<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="content-type" content="text/html; charset=ISO-8859-1" /><title>EntityDescriptionManager xref</title>
<link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" />
</head>
<body>
<div id="overview"><a href="../../../../../../../../../../apidocs/org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">View Javadoc</a></div><pre>

<a name="1" href="#1">1</a>   <em>/**<em>*</em></em>
<a name="2" href="#2">2</a>   <em> * $Id: EntityDescriptionManager.html 12 2009-01-29 12:00:24Z azeckoski $</em>
<a name="3" href="#3">3</a>   <em> * $URL: http://entitybus.googlecode.com/svn/maven/site/entitybus-rest/xref/org/sakaiproject/entitybus/rest/EntityDescriptionManager.html $</em>
<a name="4" href="#4">4</a>   <em> * EntityDescriptionManager.java - entity-broker - Jul 22, 2008 12:18:48 PM - azeckoski</em>
<a name="5" href="#5">5</a>   <em> **************************************************************************</em>
<a name="6" href="#6">6</a>   <em> * Copyright (c) 2008 Sakai Foundation</em>
<a name="7" href="#7">7</a>   <em> *</em>
<a name="8" href="#8">8</a>   <em> * Licensed under the Educational Community License, Version 2.0 (the "License");</em>
<a name="9" href="#9">9</a>   <em> * you may not use this file except in compliance with the License.</em>
<a name="10" href="#10">10</a>  <em> * You may obtain a copy of the License at</em>
<a name="11" href="#11">11</a>  <em> *</em>
<a name="12" href="#12">12</a>  <em> *       <a href="http://www.osedu.org/licenses/ECL-2.0" target="alexandria_uri">http://www.osedu.org/licenses/ECL-2.0</a></em>
<a name="13" href="#13">13</a>  <em> *</em>
<a name="14" href="#14">14</a>  <em> * Unless required by applicable law or agreed to in writing, software</em>
<a name="15" href="#15">15</a>  <em> * distributed under the License is distributed on an "AS IS" BASIS,</em>
<a name="16" href="#16">16</a>  <em> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</em>
<a name="17" href="#17">17</a>  <em> * See the License for the specific language governing permissions and</em>
<a name="18" href="#18">18</a>  <em> * limitations under the License.</em>
<a name="19" href="#19">19</a>  <em> */</em>
<a name="20" href="#20">20</a>  
<a name="21" href="#21">21</a>  <strong>package</strong> org.sakaiproject.entitybus.<strong>rest</strong>;
<a name="22" href="#22">22</a>  
<a name="23" href="#23">23</a>  <strong>import</strong> java.util.ArrayList;
<a name="24" href="#24">24</a>  <strong>import</strong> java.util.Collections;
<a name="25" href="#25">25</a>  <strong>import</strong> java.util.HashMap;
<a name="26" href="#26">26</a>  <strong>import</strong> java.util.List;
<a name="27" href="#27">27</a>  <strong>import</strong> java.util.Locale;
<a name="28" href="#28">28</a>  <strong>import</strong> java.util.Map;
<a name="29" href="#29">29</a>  <strong>import</strong> java.util.Map.Entry;
<a name="30" href="#30">30</a>  
<a name="31" href="#31">31</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityBrokerManager;
<a name="32" href="#32">32</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityReference;
<a name="33" href="#33">33</a>  <strong>import</strong> org.sakaiproject.entitybus.EntityView;
<a name="34" href="#34">34</a>  <strong>import</strong> org.sakaiproject.entitybus.access.AccessFormats;
<a name="35" href="#35">35</a>  <strong>import</strong> org.sakaiproject.entitybus.access.EntityViewAccessProvider;
<a name="36" href="#36">36</a>  <strong>import</strong> org.sakaiproject.entitybus.access.EntityViewAccessProviderManager;
<a name="37" href="#37">37</a>  <strong>import</strong> org.sakaiproject.entitybus.access.HttpServletAccessProvider;
<a name="38" href="#38">38</a>  <strong>import</strong> org.sakaiproject.entitybus.access.HttpServletAccessProviderManager;
<a name="39" href="#39">39</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.CoreEntityProvider;
<a name="40" href="#40">40</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProvider;
<a name="41" href="#41">41</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderManager;
<a name="42" href="#42">42</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.EntityProviderMethodStore;
<a name="43" href="#43">43</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.CollectionResolvable;
<a name="44" href="#44">44</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Createable;
<a name="45" href="#45">45</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Deleteable;
<a name="46" href="#46">46</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.DescribeDefineable;
<a name="47" href="#47">47</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.DescribePropertiesable;
<a name="48" href="#48">48</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Inputable;
<a name="49" href="#49">49</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Outputable;
<a name="50" href="#50">50</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Resolvable;
<a name="51" href="#51">51</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.capabilities.Updateable;
<a name="52" href="#52">52</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.CustomAction;
<a name="53" href="#53">53</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.Formats;
<a name="54" href="#54">54</a>  <strong>import</strong> org.sakaiproject.entitybus.entityprovider.extension.URLRedirect;
<a name="55" href="#55">55</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityPropertiesService;
<a name="56" href="#56">56</a>  <strong>import</strong> org.sakaiproject.entitybus.providers.EntityRequestHandler;
<a name="57" href="#57">57</a>  <strong>import</strong> org.sakaiproject.entitybus.<strong>rest</strong>.caps.BatchProvider;
<a name="58" href="#58">58</a>  <strong>import</strong> org.sakaiproject.entitybus.util.TemplateParseUtil;
<a name="59" href="#59">59</a>  <strong>import</strong> org.sakaiproject.entitybus.util.VersionConstants;
<a name="60" href="#60">60</a>  <strong>import</strong> org.apache.commons.logging.Log;
<a name="61" href="#61">61</a>  <strong>import</strong> org.apache.commons.logging.LogFactory;
<a name="62" href="#62">62</a>  <strong>import</strong> org.azeckoski.reflectutils.ArrayUtils;
<a name="63" href="#63">63</a>  <strong>import</strong> org.azeckoski.reflectutils.ConstructorUtils;
<a name="64" href="#64">64</a>  <strong>import</strong> org.azeckoski.reflectutils.ReflectUtils;
<a name="65" href="#65">65</a>  <strong>import</strong> org.azeckoski.reflectutils.ClassFields.FieldsFilter;
<a name="66" href="#66">66</a>  
<a name="67" href="#67">67</a>  
<a name="68" href="#68">68</a>  <em>/**<em>*</em></em>
<a name="69" href="#69">69</a>  <em> * This handles all the methods related to generating descriptions for entities,</em>
<a name="70" href="#70">70</a>  <em> * html and xml currently supported</em>
<a name="71" href="#71">71</a>  <em> * </em>
<a name="72" href="#72">72</a>  <em> * @author Aaron Zeckoski (azeckoski @ gmail.com)</em>
<a name="73" href="#73">73</a>  <em> */</em>
<a name="74" href="#74">74</a>  @SuppressWarnings(<span class="string">"deprecation"</span>)
<a name="75" href="#75">75</a>  <strong>public</strong> <strong>class</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a> {
<a name="76" href="#76">76</a>  
<a name="77" href="#77">77</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> Log log = LogFactory.getLog(EntityDescriptionManager.<strong>class</strong>);
<a name="78" href="#78">78</a>  
<a name="79" href="#79">79</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String INPUT_DESCRIBE_KEY = <span class="string">"input"</span>;
<a name="80" href="#80">80</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String OUTPUT_DESCRIBE_KEY = <span class="string">"output"</span>;
<a name="81" href="#81">81</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String VIEW_KEY_PREFIX = <span class="string">"view."</span>;
<a name="82" href="#82">82</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String FIELD_KEY_PREFIX = <span class="string">"field."</span>;
<a name="83" href="#83">83</a>      <strong>private</strong> <strong>static</strong> <strong>final</strong> String REDIRECT_KEY_PREFIX = <span class="string">"redirect."</span>;
<a name="84" href="#84">84</a>      <strong>protected</strong> <strong>static</strong> String ACTION_KEY_PREFIX = <span class="string">"action."</span>;
<a name="85" href="#85">85</a>      <strong>protected</strong> <strong>static</strong> String DESCRIBE = EntityRequestHandler.DESCRIBE;
<a name="86" href="#86">86</a>      <strong>protected</strong> <strong>static</strong> String SLASH_DESCRIBE = EntityRequestHandler.SLASH_DESCRIBE;
<a name="87" href="#87">87</a>      <strong>protected</strong> <strong>static</strong> String FAKE_ID = EntityRequestHandler.FAKE_ID;
<a name="88" href="#88">88</a>  
<a name="89" href="#89">89</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> String XML_HEADER = <span class="string">"&lt;?xml version=\&quot;1.0\&quot; encoding=\&quot;UTF-8\&quot; ?>\n"</span>;
<a name="90" href="#90">90</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> String XHTML_HEADER = <span class="string">"&lt;!DOCTYPE html PUBLIC \&quot;-//W3C//DTD XHTML 1.0 Transitional//EN\&quot; "</span> +
<a name="91" href="#91">91</a>      <span class="string">"\&quot;http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\&quot;>\n"</span> +
<a name="92" href="#92">92</a>      <span class="string">"&lt;html xmlns=\&quot;http://www.w3.org/1999/xhtml\&quot;>\n"</span> +
<a name="93" href="#93">93</a>      <span class="string">"&lt;head>\n"</span> +
<a name="94" href="#94">94</a>      <span class="string">"  &lt;meta http-equiv=\&quot;Content-Type\&quot; content=\&quot;text/html; charset=UTF-8\&quot; />\n"</span> +
<a name="95" href="#95">95</a>      <span class="string">"  &lt;title>Describe Entities&lt;/title>\n"</span> +
<a name="96" href="#96">96</a>      <span class="string">"&lt;/head>\n"</span> +
<a name="97" href="#97">97</a>      <span class="string">"&lt;body>\n"</span>;
<a name="98" href="#98">98</a>      <em class="comment">// include versions info in the footer now</em>
<a name="99" href="#99">99</a>      <strong>protected</strong> <strong>static</strong> <strong>final</strong> String XHTML_FOOTER = <span class="string">"&lt;br/>\n&lt;div style='width:100%;text-align:center;font-style:italic;font-size:0.9em;'>"</span>
<a name="100" href="#100">100</a>     		+ <span class="string">"&lt;b>"</span> + VersionConstants.APP_VERSION + <span class="string">"&lt;/b> :: SVN: "</span> + VersionConstants.SVN_REVISION 
<a name="101" href="#101">101</a>     		+ <span class="string">" : "</span> + VersionConstants.SVN_LAST_UPDATE + <span class="string">"&lt;/div>"</span>
<a name="102" href="#102">102</a>     		+ <span class="string">"\n&lt;/body>\n&lt;/html>\n"</span>;
<a name="103" href="#103">103</a> 
<a name="104" href="#104">104</a>     
<a name="105" href="#105">105</a>     <strong>protected</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a>() { }
<a name="106" href="#106">106</a> 
<a name="107" href="#107">107</a>     <em>/**<em>*</em></em>
<a name="108" href="#108">108</a> <em>     * Full constructor</em>
<a name="109" href="#109">109</a> <em>     * @param entityViewAccessProviderManager</em>
<a name="110" href="#110">110</a> <em>     * @param httpServletAccessProviderManager</em>
<a name="111" href="#111">111</a> <em>     * @param entityProviderManager</em>
<a name="112" href="#112">112</a> <em>     * @param entityProperties</em>
<a name="113" href="#113">113</a> <em>     * @param entityBrokerManager</em>
<a name="114" href="#114">114</a> <em>     * @param entityProviderMethodStore</em>
<a name="115" href="#115">115</a> <em>     */</em>
<a name="116" href="#116">116</a>     <strong>public</strong> <a href="../../../../org/sakaiproject/entitybus/rest/EntityDescriptionManager.html">EntityDescriptionManager</a>(
<a name="117" href="#117">117</a>             EntityViewAccessProviderManager entityViewAccessProviderManager,
<a name="118" href="#118">118</a>             HttpServletAccessProviderManager httpServletAccessProviderManager,
<a name="119" href="#119">119</a>             EntityProviderManager entityProviderManager, EntityPropertiesService entityProperties,
<a name="120" href="#120">120</a>             EntityBrokerManager entityBrokerManager,
<a name="121" href="#121">121</a>             EntityProviderMethodStore entityProviderMethodStore) {
<a name="122" href="#122">122</a>         <strong>super</strong>();
<a name="123" href="#123">123</a>         <strong>this</strong>.entityViewAccessProviderManager = entityViewAccessProviderManager;
<a name="124" href="#124">124</a>         <strong>this</strong>.httpServletAccessProviderManager = httpServletAccessProviderManager;
<a name="125" href="#125">125</a>         <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="126" href="#126">126</a>         <strong>this</strong>.entityProperties = entityProperties;
<a name="127" href="#127">127</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="128" href="#128">128</a>         <strong>this</strong>.entityProviderMethodStore = entityProviderMethodStore;
<a name="129" href="#129">129</a>         init();
<a name="130" href="#130">130</a>     }
<a name="131" href="#131">131</a> 
<a name="132" href="#132">132</a>     <strong>private</strong> EntityProvider describeEP = <strong>null</strong>;
<a name="133" href="#133">133</a>     <strong>private</strong> EntityProvider batchEP = <strong>null</strong>;
<a name="134" href="#134">134</a>     <strong>public</strong> <strong>void</strong> init() {
<a name="135" href="#135">135</a>         log.info(<span class="string">"init"</span>);
<a name="136" href="#136">136</a>         <em class="comment">// register the describe and batch prefixes to load up descriptions</em>
<a name="137" href="#137">137</a>         describeEP = <strong>new</strong> DescribePropertiesable() {
<a name="138" href="#138">138</a>             <strong>public</strong> String getEntityPrefix() {
<a name="139" href="#139">139</a>                 <strong>return</strong> EntityRequestHandler.DESCRIBE;
<a name="140" href="#140">140</a>             }
<a name="141" href="#141">141</a>             <strong>public</strong> String getBaseName() {
<a name="142" href="#142">142</a>                 <strong>return</strong> getEntityPrefix();
<a name="143" href="#143">143</a>             }
<a name="144" href="#144">144</a>             <strong>public</strong> ClassLoader getResourceClassLoader() {
<a name="145" href="#145">145</a>                 <strong>return</strong> EntityDescriptionManager.<strong>class</strong>.getClassLoader();
<a name="146" href="#146">146</a>             }
<a name="147" href="#147">147</a>         };
<a name="148" href="#148">148</a>         entityProviderManager.registerEntityProvider(describeEP);
<a name="149" href="#149">149</a> 
<a name="150" href="#150">150</a>         batchEP = <strong>new</strong> <a href="../../../../org/sakaiproject/entitybus/rest/caps/BatchProvider.html">BatchProvider</a>() {
<a name="151" href="#151">151</a>             <strong>public</strong> String getEntityPrefix() {
<a name="152" href="#152">152</a>                 <strong>return</strong> EntityRequestHandler.BATCH;
<a name="153" href="#153">153</a>             }
<a name="154" href="#154">154</a>             <strong>public</strong> String getBaseName() {
<a name="155" href="#155">155</a>                 <strong>return</strong> getEntityPrefix();
<a name="156" href="#156">156</a>             }
<a name="157" href="#157">157</a>             <strong>public</strong> ClassLoader getResourceClassLoader() {
<a name="158" href="#158">158</a>                 <strong>return</strong> EntityDescriptionManager.<strong>class</strong>.getClassLoader();
<a name="159" href="#159">159</a>             }
<a name="160" href="#160">160</a>             <strong>public</strong> String[] getHandledOutputFormats() {
<a name="161" href="#161">161</a>                 <strong>return</strong> EntityEncodingManager.HANDLED_OUTPUT_FORMATS;
<a name="162" href="#162">162</a>             }
<a name="163" href="#163">163</a>         };
<a name="164" href="#164">164</a>         entityProviderManager.registerEntityProvider(batchEP);
<a name="165" href="#165">165</a>     }
<a name="166" href="#166">166</a> 
<a name="167" href="#167">167</a>     <strong>public</strong> <strong>void</strong> destroy() {
<a name="168" href="#168">168</a>         log.info(<span class="string">"destroy"</span>);
<a name="169" href="#169">169</a>         <strong>if</strong> (describeEP != <strong>null</strong>) {
<a name="170" href="#170">170</a>             <strong>try</strong> {
<a name="171" href="#171">171</a>                 entityProviderManager.unregisterEntityProvider(describeEP);
<a name="172" href="#172">172</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="173" href="#173">173</a>                 log.warn(<span class="string">"Unable to unregister the describe and batch description providers"</span>);
<a name="174" href="#174">174</a>             }
<a name="175" href="#175">175</a>         }
<a name="176" href="#176">176</a>         <strong>if</strong> (batchEP != <strong>null</strong>) {
<a name="177" href="#177">177</a>             <strong>try</strong> {
<a name="178" href="#178">178</a>                 entityProviderManager.unregisterEntityProvider(batchEP);
<a name="179" href="#179">179</a>             } <strong>catch</strong> (RuntimeException e) {
<a name="180" href="#180">180</a>                 log.warn(<span class="string">"Unable to unregister the describe and batch description providers"</span>);
<a name="181" href="#181">181</a>             }
<a name="182" href="#182">182</a>         }
<a name="183" href="#183">183</a>     }
<a name="184" href="#184">184</a> 
<a name="185" href="#185">185</a>     <strong>private</strong> EntityViewAccessProviderManager entityViewAccessProviderManager;
<a name="186" href="#186">186</a>     <strong>public</strong> <strong>void</strong> setEntityViewAccessProviderManager(
<a name="187" href="#187">187</a>             EntityViewAccessProviderManager entityViewAccessProviderManager) {
<a name="188" href="#188">188</a>         <strong>this</strong>.entityViewAccessProviderManager = entityViewAccessProviderManager;
<a name="189" href="#189">189</a>     }
<a name="190" href="#190">190</a> 
<a name="191" href="#191">191</a>     <strong>private</strong> HttpServletAccessProviderManager httpServletAccessProviderManager;
<a name="192" href="#192">192</a>     <strong>public</strong> <strong>void</strong> setHttpServletAccessProviderManager(
<a name="193" href="#193">193</a>             HttpServletAccessProviderManager httpServletAccessProviderManager) {
<a name="194" href="#194">194</a>         <strong>this</strong>.httpServletAccessProviderManager = httpServletAccessProviderManager;
<a name="195" href="#195">195</a>     }
<a name="196" href="#196">196</a> 
<a name="197" href="#197">197</a>     <strong>private</strong> EntityProviderManager entityProviderManager;
<a name="198" href="#198">198</a>     <strong>public</strong> <strong>void</strong> setEntityProviderManager(EntityProviderManager entityProviderManager) {
<a name="199" href="#199">199</a>         <strong>this</strong>.entityProviderManager = entityProviderManager;
<a name="200" href="#200">200</a>     }
<a name="201" href="#201">201</a> 
<a name="202" href="#202">202</a>     <strong>private</strong> EntityPropertiesService entityProperties;
<a name="203" href="#203">203</a>     <strong>public</strong> <strong>void</strong> setEntityProperties(EntityPropertiesService entityProperties) {
<a name="204" href="#204">204</a>         <strong>this</strong>.entityProperties = entityProperties;
<a name="205" href="#205">205</a>     }
<a name="206" href="#206">206</a> 
<a name="207" href="#207">207</a>     <strong>private</strong> EntityBrokerManager entityBrokerManager;
<a name="208" href="#208">208</a>     <strong>public</strong> <strong>void</strong> setEntityBrokerManager(EntityBrokerManager entityBrokerManager) {
<a name="209" href="#209">209</a>         <strong>this</strong>.entityBrokerManager = entityBrokerManager;
<a name="210" href="#210">210</a>     }
<a name="211" href="#211">211</a> 
<a name="212" href="#212">212</a>     <strong>private</strong> EntityProviderMethodStore entityProviderMethodStore;
<a name="213" href="#213">213</a>     <strong>public</strong> <strong>void</strong> setEntityProviderMethodStore(EntityProviderMethodStore entityProviderMethodStore) {
<a name="214" href="#214">214</a>         <strong>this</strong>.entityProviderMethodStore = entityProviderMethodStore;
<a name="215" href="#215">215</a>     }
<a name="216" href="#216">216</a> 
<a name="217" href="#217">217</a> 
<a name="218" href="#218">218</a>     <em>/**<em>*</em></em>
<a name="219" href="#219">219</a> <em>     * Generate a description of all entities in the system,</em>
<a name="220" href="#220">220</a> <em>     * this is only available as XML and XHTML</em>
<a name="221" href="#221">221</a> <em>     * </em>
<a name="222" href="#222">222</a> <em>     * @param format XML or HTML (default is HTML)</em>
<a name="223" href="#223">223</a> <em>     * @param locale the locale to use for any translations</em>
<a name="224" href="#224">224</a> <em>     * @return the description string for all known entities</em>
<a name="225" href="#225">225</a> <em>     */</em>
<a name="226" href="#226">226</a>     <strong>public</strong> String makeDescribeAll(String format, Locale locale) {
<a name="227" href="#227">227</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="228" href="#228">228</a>             locale = entityProperties.getLocale();
<a name="229" href="#229">229</a>         }
<a name="230" href="#230">230</a>         Map&lt;String, List&lt;Class&lt;? <strong>extends</strong> EntityProvider>>> map = entityProviderManager.getRegisteredEntityCapabilities();
<a name="231" href="#231">231</a>         <em class="comment">// take out the "describe" EP if it is in there</em>
<a name="232" href="#232">232</a>         map.remove(DESCRIBE);
<a name="233" href="#233">233</a>         <em class="comment">// now get to creating the descriptions</em>
<a name="234" href="#234">234</a>         String describeURL = entityBrokerManager.makeFullURL(<span class="string">""</span>) + SLASH_DESCRIBE;
<a name="235" href="#235">235</a>         String output = <span class="string">""</span>;
<a name="236" href="#236">236</a>         <strong>if</strong> (Formats.XML.equals(format)) {
<a name="237" href="#237">237</a>             <em class="comment">// XML available in case someone wants to parse this in javascript or whatever</em>
<a name="238" href="#238">238</a>             StringBuilder sb = <strong>new</strong> StringBuilder(200);
<a name="239" href="#239">239</a>             sb.append(XML_HEADER);
<a name="240" href="#240">240</a>             sb.append(<span class="string">"&lt;describe>\n"</span>);
<a name="241" href="#241">241</a>             sb.append(<span class="string">"  &lt;describeURL>"</span> + describeURL + <span class="string">"&lt;/describeURL>\n"</span>);
<a name="242" href="#242">242</a>             sb.append( makeXMLVersion() );
<a name="243" href="#243">243</a>             sb.append(<span class="string">"  &lt;prefixes>\n"</span>);
<a name="244" href="#244">244</a>             ArrayList&lt;String> prefixes = <strong>new</strong> ArrayList&lt;String>(map.keySet());
<a name="245" href="#245">245</a>             Collections.sort(prefixes);
<a name="246" href="#246">246</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; prefixes.size(); i++) {
<a name="247" href="#247">247</a>                 String prefix = prefixes.get(i);
<a name="248" href="#248">248</a>                 describeEntity(sb, prefix, FAKE_ID, format, false, map.get(prefix), locale);
<a name="249" href="#249">249</a>             }
<a name="250" href="#250">250</a>             sb.append(<span class="string">"  &lt;/prefixes>\n"</span>);
<a name="251" href="#251">251</a>             sb.append(<span class="string">"&lt;/describe>\n"</span>);
<a name="252" href="#252">252</a>             output = sb.toString();
<a name="253" href="#253">253</a>         } <strong>else</strong> {
<a name="254" href="#254">254</a>             <em class="comment">// just do HTML if not one of the handled ones</em>
<a name="255" href="#255">255</a>             StringBuilder sb = <strong>new</strong> StringBuilder(300);
<a name="256" href="#256">256</a>             sb.append(XML_HEADER);
<a name="257" href="#257">257</a>             sb.append(XHTML_HEADER);
<a name="258" href="#258">258</a>             sb.append(<span class="string">"&lt;h1>&lt;a href='"</span>+ describeURL +<span class="string">"'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.all"</span>, locale)+<span class="string">"&lt;/a> "</span>
<a name="259" href="#259">259</a>                     + entityProperties.getProperty(DESCRIBE, <span class="string">"describe.registered.entities"</span>, locale)
<a name="260" href="#260">260</a>                     + makeFormatUrlHtml(describeURL, Formats.XML) +<span class="string">"&lt;/h1>\n"</span>);
<a name="261" href="#261">261</a>             sb.append(<span class="string">"  &lt;i>RESTful URLs: &lt;a href='http://microformats.org/wiki/rest/urls'>http://microformats.org/wiki/rest/urls&lt;/a>&lt;/i>&lt;br/>\n"</span>);
<a name="262" href="#262">262</a>             sb.append(<span class="string">"  &lt;h2>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.all"</span>, locale)+<span class="string">" ("</span>
<a name="263" href="#263">263</a>                     +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.registered.entities"</span>, locale)+<span class="string">"): "</span>
<a name="264" href="#264">264</a>                     +map.size()+<span class="string">"&lt;/h2>\n"</span>);
<a name="265" href="#265">265</a>             sb.append(<span class="string">"  &lt;div style='font-style:italic;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.searching"</span>, locale)+<span class="string">"&lt;/div>\n"</span>); <em class="comment">// searching</em>
<a name="266" href="#266">266</a>             ArrayList&lt;String> prefixes = <strong>new</strong> ArrayList&lt;String>(map.keySet());
<a name="267" href="#267">267</a>             Collections.sort(prefixes);
<a name="268" href="#268">268</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; prefixes.size(); i++) {
<a name="269" href="#269">269</a>                 String prefix = prefixes.get(i);
<a name="270" href="#270">270</a>                 describeEntity(sb, prefix, FAKE_ID, format, false, map.get(prefix), locale);
<a name="271" href="#271">271</a>             }
<a name="272" href="#272">272</a>             sb.append(XHTML_FOOTER);
<a name="273" href="#273">273</a>             output = sb.toString();
<a name="274" href="#274">274</a>         }
<a name="275" href="#275">275</a>         <strong>return</strong> output;
<a name="276" href="#276">276</a>     }
<a name="277" href="#277">277</a> 
<a name="278" href="#278">278</a>     <em>/**<em>*</em></em>
<a name="279" href="#279">279</a> <em>     * @return the XML tags string that contains the XML version info</em>
<a name="280" href="#280">280</a> <em>     */</em>
<a name="281" href="#281">281</a>     <strong>private</strong> String makeXMLVersion() {
<a name="282" href="#282">282</a>         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="283" href="#283">283</a>         sb.append(<span class="string">"  &lt;version>"</span> + VersionConstants.APP_VERSION + <span class="string">"&lt;/version>\n"</span>);
<a name="284" href="#284">284</a>         sb.append(<span class="string">"  &lt;svn>\n"</span>);
<a name="285" href="#285">285</a>         sb.append(<span class="string">"    &lt;revision>"</span>+VersionConstants.SVN_REVISION+<span class="string">"&lt;/revision>\n"</span>);
<a name="286" href="#286">286</a>         sb.append(<span class="string">"    &lt;last-update>"</span>+VersionConstants.SVN_LAST_UPDATE+<span class="string">"&lt;/last-update>\n"</span>);
<a name="287" href="#287">287</a>         sb.append(<span class="string">"  &lt;/svn>\n"</span>);
<a name="288" href="#288">288</a>         <strong>return</strong> sb.toString();
<a name="289" href="#289">289</a>     }
<a name="290" href="#290">290</a> 
<a name="291" href="#291">291</a> 
<a name="292" href="#292">292</a>     <em>/**<em>*</em></em>
<a name="293" href="#293">293</a> <em>     * Generate a description of an entity type</em>
<a name="294" href="#294">294</a> <em>     * </em>
<a name="295" href="#295">295</a> <em>     * @param prefix an entity prefix</em>
<a name="296" href="#296">296</a> <em>     * @param id the entity id to use for generating URLs</em>
<a name="297" href="#297">297</a> <em>     * @param format a format to output, HTML and XML supported</em>
<a name="298" href="#298">298</a> <em>     * @param locale the locale to use for translations</em>
<a name="299" href="#299">299</a> <em>     * @return the description string</em>
<a name="300" href="#300">300</a> <em>     * @throws IllegalArgumentException if the entity does not exist</em>
<a name="301" href="#301">301</a> <em>     */</em>
<a name="302" href="#302">302</a>     <strong>public</strong> String makeDescribeEntity(String prefix, String id, String format, Locale locale) {
<a name="303" href="#303">303</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="304" href="#304">304</a>             locale = entityProperties.getLocale();
<a name="305" href="#305">305</a>         }
<a name="306" href="#306">306</a>         <strong>if</strong> (entityProviderManager.getProviderByPrefix(prefix) == <strong>null</strong>) {
<a name="307" href="#307">307</a>             <strong>throw</strong> <strong>new</strong> IllegalArgumentException(<span class="string">"Invalid prefix ("</span>+prefix+<span class="string">"), entity with that prefix does not exist"</span>);
<a name="308" href="#308">308</a>         }
<a name="309" href="#309">309</a>         StringBuilder sb = <strong>new</strong> StringBuilder(250);
<a name="310" href="#310">310</a>         <strong>if</strong> (Formats.XML.equals(format)) {
<a name="311" href="#311">311</a>             sb.append(XML_HEADER);
<a name="312" href="#312">312</a>             describeEntity(sb, prefix, id, format, <strong>true</strong>, <strong>null</strong>, locale);
<a name="313" href="#313">313</a>         } <strong>else</strong> {
<a name="314" href="#314">314</a>             <em class="comment">// just do HTML if not one of the handled ones</em>
<a name="315" href="#315">315</a>             sb.append(XML_HEADER);
<a name="316" href="#316">316</a>             sb.append(XHTML_HEADER);
<a name="317" href="#317">317</a>             describeEntity(sb, prefix, id, format, <strong>true</strong>, <strong>null</strong>, locale);
<a name="318" href="#318">318</a>             sb.append(XHTML_FOOTER);
<a name="319" href="#319">319</a>         }
<a name="320" href="#320">320</a>         <strong>return</strong> sb.toString();
<a name="321" href="#321">321</a>     }
<a name="322" href="#322">322</a> 
<a name="323" href="#323">323</a>     <em>/**<em>*</em></em>
<a name="324" href="#324">324</a> <em>     * This is reducing code duplication</em>
<a name="325" href="#325">325</a> <em>     * @param sb</em>
<a name="326" href="#326">326</a> <em>     * @param prefix</em>
<a name="327" href="#327">327</a> <em>     * @param id</em>
<a name="328" href="#328">328</a> <em>     * @param format</em>
<a name="329" href="#329">329</a> <em>     * @param extra</em>
<a name="330" href="#330">330</a> <em>     * @param caps</em>
<a name="331" href="#331">331</a> <em>     * @param locale used for translations</em>
<a name="332" href="#332">332</a> <em>     * @return the entity description</em>
<a name="333" href="#333">333</a> <em>     */</em>
<a name="334" href="#334">334</a>     @SuppressWarnings(<span class="string">"unchecked"</span>)
<a name="335" href="#335">335</a>     <strong>protected</strong> String describeEntity(StringBuilder sb, String prefix, String id, String format, <strong>boolean</strong> extra, List&lt;Class&lt;? <strong>extends</strong> EntityProvider>> caps, Locale locale) {
<a name="336" href="#336">336</a>         <strong>if</strong> (caps == <strong>null</strong>) {
<a name="337" href="#337">337</a>             caps = entityProviderManager.getPrefixCapabilities(prefix);
<a name="338" href="#338">338</a>         }
<a name="339" href="#339">339</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="340" href="#340">340</a>             locale = entityProperties.getLocale();
<a name="341" href="#341">341</a>         }
<a name="342" href="#342">342</a>         String directUrl = entityBrokerManager.makeFullURL(<span class="string">""</span>);
<a name="343" href="#343">343</a>         <strong>if</strong> (Formats.XML.equals(format)) {
<a name="344" href="#344">344</a>             <em class="comment">// XML available in case someone wants to parse this in javascript or whatever</em>
<a name="345" href="#345">345</a>             String describePrefixUrl = directUrl + <span class="string">"/"</span> + prefix + SLASH_DESCRIBE;
<a name="346" href="#346">346</a>             sb.append(<span class="string">"    &lt;prefix>\n"</span>);
<a name="347" href="#347">347</a>             sb.append(<span class="string">"      &lt;prefix>"</span> + prefix + <span class="string">"&lt;/prefix>\n"</span>);
<a name="348" href="#348">348</a>             sb.append(<span class="string">"      &lt;describeURL>"</span> + describePrefixUrl + <span class="string">"&lt;/describeURL>\n"</span>);
<a name="349" href="#349">349</a>             String description = getEntityDescription(prefix, <strong>null</strong>, locale);
<a name="350" href="#350">350</a>             <strong>if</strong> (description != <strong>null</strong>) {
<a name="351" href="#351">351</a>                 sb.append(<span class="string">"      &lt;description>"</span> + description + <span class="string">"&lt;/description>\n"</span>);            
<a name="352" href="#352">352</a>             }
<a name="353" href="#353">353</a>             <strong>if</strong> (extra) {
<a name="354" href="#354">354</a>                 <em class="comment">// URLs</em>
<a name="355" href="#355">355</a>                 EntityView ev = entityBrokerManager.makeEntityView(<strong>new</strong> EntityReference(prefix, id), <strong>null</strong>, <strong>null</strong>);
<a name="356" href="#356">356</a>                 <strong>if</strong> (caps.contains(CollectionResolvable.<strong>class</strong>)) {
<a name="357" href="#357">357</a>                     sb.append(<span class="string">"      &lt;collectionURL>"</span> + ev.getEntityURL(EntityView.VIEW_LIST, <strong>null</strong>) + <span class="string">"&lt;/collectionURL>\n"</span>);
<a name="358" href="#358">358</a>                     String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_LIST, locale);
<a name="359" href="#359">359</a>                     <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="360" href="#360">360</a>                         sb.append(<span class="string">"      &lt;collectionDescription>"</span>+viewDesc+<span class="string">"&lt;/collectionDescription>\n"</span>);
<a name="361" href="#361">361</a>                     }
<a name="362" href="#362">362</a>                 }
<a name="363" href="#363">363</a>                 <strong>if</strong> (caps.contains(Createable.<strong>class</strong>)) {
<a name="364" href="#364">364</a>                     sb.append(<span class="string">"      &lt;createURL>"</span> + ev.getEntityURL(EntityView.VIEW_NEW, <strong>null</strong>) + <span class="string">"&lt;/createURL>\n"</span>);
<a name="365" href="#365">365</a>                     String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_NEW, locale);
<a name="366" href="#366">366</a>                     <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="367" href="#367">367</a>                         sb.append(<span class="string">"      &lt;createDescription>"</span>+viewDesc+<span class="string">"&lt;/createDescription>\n"</span>);
<a name="368" href="#368">368</a>                     }
<a name="369" href="#369">369</a>                 }
<a name="370" href="#370">370</a>                 <strong>if</strong> (caps.contains(CoreEntityProvider.<strong>class</strong>) || caps.contains(Resolvable.<strong>class</strong>)) {
<a name="371" href="#371">371</a>                     sb.append(<span class="string">"      &lt;showURL>"</span> + ev.getEntityURL(EntityView.VIEW_SHOW, <strong>null</strong>) + <span class="string">"&lt;/showURL>\n"</span>);
<a name="372" href="#372">372</a>                     String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_SHOW, locale);
<a name="373" href="#373">373</a>                     <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="374" href="#374">374</a>                         sb.append(<span class="string">"      &lt;showDescription>"</span>+viewDesc+<span class="string">"&lt;/showDescription>\n"</span>);
<a name="375" href="#375">375</a>                     }
<a name="376" href="#376">376</a>                 }
<a name="377" href="#377">377</a>                 <strong>if</strong> (caps.contains(Updateable.<strong>class</strong>)) {
<a name="378" href="#378">378</a>                     sb.append(<span class="string">"      &lt;updateURL>"</span> + ev.getEntityURL(EntityView.VIEW_EDIT, <strong>null</strong>) + <span class="string">"&lt;/updateURL>\n"</span>);
<a name="379" href="#379">379</a>                     String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_EDIT, locale);
<a name="380" href="#380">380</a>                     <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="381" href="#381">381</a>                         sb.append(<span class="string">"      &lt;updateDescription>"</span>+viewDesc+<span class="string">"&lt;/updateDescription>\n"</span>);
<a name="382" href="#382">382</a>                     }
<a name="383" href="#383">383</a>                 }
<a name="384" href="#384">384</a>                 <strong>if</strong> (caps.contains(Deleteable.<strong>class</strong>)) {
<a name="385" href="#385">385</a>                     sb.append(<span class="string">"      &lt;deleteURL>"</span> + ev.getEntityURL(EntityView.VIEW_DELETE, <strong>null</strong>) + <span class="string">"&lt;/deleteURL>\n"</span>);
<a name="386" href="#386">386</a>                     String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_DELETE, locale);
<a name="387" href="#387">387</a>                     <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="388" href="#388">388</a>                         sb.append(<span class="string">"      &lt;deleteDescription>"</span>+viewDesc+<span class="string">"&lt;/deleteDescription>\n"</span>);
<a name="389" href="#389">389</a>                     }
<a name="390" href="#390">390</a>                 }
<a name="391" href="#391">391</a>                 <em class="comment">// Custom Actions</em>
<a name="392" href="#392">392</a>                 List&lt;CustomAction> customActions = entityProviderMethodStore.getCustomActions(prefix);
<a name="393" href="#393">393</a>                 <strong>if</strong> (! customActions.isEmpty()) {
<a name="394" href="#394">394</a>                     <strong>for</strong> (CustomAction customAction : customActions) {
<a name="395" href="#395">395</a>                         sb.append(<span class="string">"      &lt;customActions>\n"</span>);
<a name="396" href="#396">396</a>                         sb.append(<span class="string">"        &lt;customAction>\n"</span>);
<a name="397" href="#397">397</a>                         sb.append(<span class="string">"          &lt;action>"</span>+customAction.action+<span class="string">"&lt;/action>\n"</span>);
<a name="398" href="#398">398</a>                         sb.append(<span class="string">"          &lt;url>"</span>+directUrl+makeActionURL(ev, customAction)+<span class="string">"&lt;/url>\n"</span>);
<a name="399" href="#399">399</a>                         <strong>if</strong> (customAction.viewKey == <strong>null</strong> || <span class="string">""</span>.equals(customAction.viewKey)) {
<a name="400" href="#400">400</a>                             sb.append(<span class="string">"          &lt;method/>\n"</span>);
<a name="401" href="#401">401</a>                             sb.append(<span class="string">"          &lt;viewKey/>\n"</span>);
<a name="402" href="#402">402</a>                         } <strong>else</strong> {
<a name="403" href="#403">403</a>                             sb.append(<span class="string">"          &lt;method>"</span>+EntityView.translateViewKeyToMethod(customAction.viewKey)+<span class="string">"&lt;/method>\n"</span>);
<a name="404" href="#404">404</a>                             sb.append(<span class="string">"          &lt;viewKey>"</span>+customAction.viewKey+<span class="string">"&lt;/viewKey>\n"</span>);
<a name="405" href="#405">405</a>                         }
<a name="406" href="#406">406</a>                         String actionDesc = getEntityDescription(prefix, ACTION_KEY_PREFIX + customAction.action, locale);
<a name="407" href="#407">407</a>                         <strong>if</strong> (actionDesc != <strong>null</strong>) {
<a name="408" href="#408">408</a>                             sb.append(<span class="string">"          &lt;description>"</span>+actionDesc+<span class="string">"&lt;/description>\n"</span>);
<a name="409" href="#409">409</a>                         }
<a name="410" href="#410">410</a>                         sb.append(<span class="string">"        &lt;/customAction>\n"</span>);
<a name="411" href="#411">411</a>                         sb.append(<span class="string">"      &lt;/customActions>\n"</span>);               
<a name="412" href="#412">412</a>                     }
<a name="413" href="#413">413</a>                 }
<a name="414" href="#414">414</a> 
<a name="415" href="#415">415</a>                 <em class="comment">// Data and request handling</em>
<a name="416" href="#416">416</a>                 <em class="comment">// Formats</em>
<a name="417" href="#417">417</a>                 String[] outputFormats = getFormats(prefix, <strong>true</strong>);
<a name="418" href="#418">418</a>                 sb.append(<span class="string">"      &lt;outputFormats>\n"</span>);
<a name="419" href="#419">419</a>                 <strong>if</strong> (outputFormats != <strong>null</strong>) {
<a name="420" href="#420">420</a>                     <strong>if</strong> (outputFormats.length == 0) {
<a name="421" href="#421">421</a>                         sb.append(<span class="string">"        &lt;format>*&lt;/format>\n"</span>);
<a name="422" href="#422">422</a>                     } <strong>else</strong> {
<a name="423" href="#423">423</a>                         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; outputFormats.length; i++) {
<a name="424" href="#424">424</a>                             sb.append(<span class="string">"        &lt;format>"</span>+outputFormats[i]+<span class="string">"&lt;/format>\n"</span>);
<a name="425" href="#425">425</a>                         }
<a name="426" href="#426">426</a>                     }
<a name="427" href="#427">427</a>                 }
<a name="428" href="#428">428</a>                 String outputDesc = getEntityDescription(prefix, OUTPUT_DESCRIBE_KEY, locale);
<a name="429" href="#429">429</a>                 <strong>if</strong> (outputDesc != <strong>null</strong>) {
<a name="430" href="#430">430</a>                     sb.append(<span class="string">"          &lt;description>"</span>+outputDesc+<span class="string">"&lt;/description>\n"</span>);
<a name="431" href="#431">431</a>                 }
<a name="432" href="#432">432</a>                 sb.append(<span class="string">"       &lt;/outputFormats>\n"</span>);
<a name="433" href="#433">433</a> 
<a name="434" href="#434">434</a>                 String[] inputFormats = getFormats(prefix, false);
<a name="435" href="#435">435</a>                 sb.append(<span class="string">"      &lt;inputFormats>\n"</span>);
<a name="436" href="#436">436</a>                 <strong>if</strong> (inputFormats != <strong>null</strong>) {
<a name="437" href="#437">437</a>                     <strong>if</strong> (inputFormats.length == 0) {
<a name="438" href="#438">438</a>                         sb.append(<span class="string">"        &lt;format>*&lt;/format>\n"</span>);
<a name="439" href="#439">439</a>                     } <strong>else</strong> {
<a name="440" href="#440">440</a>                         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; inputFormats.length; i++) {
<a name="441" href="#441">441</a>                             sb.append(<span class="string">"        &lt;format>"</span>+inputFormats[i]+<span class="string">"&lt;/format>\n"</span>);
<a name="442" href="#442">442</a>                         }
<a name="443" href="#443">443</a>                     }
<a name="444" href="#444">444</a>                 }
<a name="445" href="#445">445</a>                 String intputDesc = getEntityDescription(prefix, INPUT_DESCRIBE_KEY, locale);
<a name="446" href="#446">446</a>                 <strong>if</strong> (intputDesc != <strong>null</strong>) {
<a name="447" href="#447">447</a>                     sb.append(<span class="string">"          &lt;description>"</span>+intputDesc+<span class="string">"&lt;/description>\n"</span>);
<a name="448" href="#448">448</a>                 }
<a name="449" href="#449">449</a>                 sb.append(<span class="string">"       &lt;/inputFormats>\n"</span>);
<a name="450" href="#450">450</a> 
<a name="451" href="#451">451</a>                 EntityViewAccessProvider evap = entityViewAccessProviderManager.getProvider(prefix);
<a name="452" href="#452">452</a>                 HttpServletAccessProvider hsap = httpServletAccessProviderManager.getProvider(prefix);
<a name="453" href="#453">453</a>                 <strong>if</strong> (evap != <strong>null</strong> || hsap != <strong>null</strong>) {
<a name="454" href="#454">454</a>                     sb.append(<span class="string">"      &lt;accessProvider>\n"</span>);
<a name="455" href="#455">455</a>                     <strong>if</strong> (evap != <strong>null</strong>) {
<a name="456" href="#456">456</a>                         sb.append(<span class="string">"        &lt;type>"</span> + EntityViewAccessProvider.<strong>class</strong>.getSimpleName() + <span class="string">"&lt;/type>\n"</span>);
<a name="457" href="#457">457</a>                         sb.append(<span class="string">"        &lt;implementor>"</span> + evap.getClass().getName() + <span class="string">"&lt;/implementor>\n"</span>);
<a name="458" href="#458">458</a>                         <strong>if</strong> (AccessFormats.<strong>class</strong>.isAssignableFrom(evap.getClass())) {
<a name="459" href="#459">459</a>                             String[] accessFormats = ((AccessFormats)evap).getHandledAccessFormats();
<a name="460" href="#460">460</a>                             sb.append(<span class="string">"        &lt;accessFormats>\n"</span>);
<a name="461" href="#461">461</a>                             <strong>if</strong> (accessFormats != <strong>null</strong>) {
<a name="462" href="#462">462</a>                                 <strong>if</strong> (accessFormats.length == 0) {
<a name="463" href="#463">463</a>                                     sb.append(<span class="string">"          &lt;format>*&lt;/format>\n"</span>);
<a name="464" href="#464">464</a>                                 } <strong>else</strong> {
<a name="465" href="#465">465</a>                                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; accessFormats.length; i++) {
<a name="466" href="#466">466</a>                                         sb.append(<span class="string">"          &lt;format>"</span>+accessFormats[i]+<span class="string">"&lt;/format>\n"</span>);
<a name="467" href="#467">467</a>                                     }
<a name="468" href="#468">468</a>                                 }
<a name="469" href="#469">469</a>                             }
<a name="470" href="#470">470</a>                             sb.append(<span class="string">"        &lt;/accessFormats>\n"</span>);
<a name="471" href="#471">471</a>                         }
<a name="472" href="#472">472</a>                     } <strong>else</strong> {
<a name="473" href="#473">473</a>                         sb.append(<span class="string">"        &lt;type>"</span> + HttpServletAccessProvider.<strong>class</strong>.getSimpleName() + <span class="string">"&lt;/type>\n"</span>);
<a name="474" href="#474">474</a>                         sb.append(<span class="string">"        &lt;implementor>"</span> + hsap.getClass().getName() + <span class="string">"&lt;/implementor>\n"</span>);
<a name="475" href="#475">475</a>                     }
<a name="476" href="#476">476</a>                     sb.append(<span class="string">"      &lt;/accessProvider>\n"</span>);
<a name="477" href="#477">477</a>                 }
<a name="478" href="#478">478</a> 
<a name="479" href="#479">479</a>                 <em class="comment">// Resolvable Entity Info</em>
<a name="480" href="#480">480</a>                 Object entity = entityBrokerManager.getSampleEntityObject(prefix, <strong>null</strong>);
<a name="481" href="#481">481</a>                 <strong>if</strong> (entity != <strong>null</strong>) {
<a name="482" href="#482">482</a>                     Class&lt;?> entityType = entity.getClass();
<a name="483" href="#483">483</a>                     sb.append(<span class="string">"      &lt;entityClass>\n"</span>);
<a name="484" href="#484">484</a>                     sb.append(<span class="string">"        &lt;class>"</span>+ entityType.getName() +<span class="string">"&lt;/class>\n"</span>);
<a name="485" href="#485">485</a>                     <strong>if</strong> (ConstructorUtils.isClassSimple(entityType)) {
<a name="486" href="#486">486</a>                         sb.append(<span class="string">"        &lt;type>simple&lt;/type>\n"</span>);
<a name="487" href="#487">487</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassCollection(entityType)) {
<a name="488" href="#488">488</a>                         sb.append(<span class="string">"        &lt;type>collection&lt;/type>\n"</span>);
<a name="489" href="#489">489</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassArray(entityType)) {
<a name="490" href="#490">490</a>                         sb.append(<span class="string">"        &lt;type>array&lt;/type>\n"</span>);
<a name="491" href="#491">491</a>                         sb.append(<span class="string">"        &lt;componentType>"</span>+ArrayUtils.type((Object[])entity).getName()+<span class="string">"&lt;/componentType>\n"</span>);
<a name="492" href="#492">492</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassMap(entityType)) {
<a name="493" href="#493">493</a>                         sb.append(<span class="string">"        &lt;type>map&lt;/type>\n"</span>);
<a name="494" href="#494">494</a>                         <em class="comment">// get the types of the map keys if possible</em>
<a name="495" href="#495">495</a>                         Map m = (Map) entity;
<a name="496" href="#496">496</a>                         <strong>if</strong> (m.size() > 0) {
<a name="497" href="#497">497</a>                             Entry entry = (Entry) m.entrySet().iterator().next();
<a name="498" href="#498">498</a>                             sb.append(<span class="string">"        &lt;keyType>"</span>+(entry.getKey()==<strong>null</strong>?Object.<strong>class</strong>.getName():entry.getKey().getClass().getName())+<span class="string">"&lt;/keyType>\n"</span>);
<a name="499" href="#499">499</a>                             sb.append(<span class="string">"        &lt;valueType>"</span>+(entry.getValue()==<strong>null</strong>?Object.<strong>class</strong>.getName():entry.getValue().getClass().getName())+<span class="string">"&lt;/valueType>\n"</span>);
<a name="500" href="#500">500</a>                         }
<a name="501" href="#501">501</a>                     } <strong>else</strong> {
<a name="502" href="#502">502</a>                         sb.append(<span class="string">"        &lt;type>bean&lt;/type>\n"</span>);
<a name="503" href="#503">503</a>                         sb.append(<span class="string">"        &lt;fields>\n"</span>);
<a name="504" href="#504">504</a>                         <em class="comment">// get all the read and write fields from this object</em>
<a name="505" href="#505">505</a>                         Map&lt;String, Class&lt;?>> readTypes = ReflectUtils.getInstance().getFieldTypes(entity.getClass(), FieldsFilter.SERIALIZABLE);
<a name="506" href="#506">506</a>                         Map&lt;String, Class&lt;?>> writeTypes = ReflectUtils.getInstance().getFieldTypes(entity.getClass(), FieldsFilter.WRITEABLE);
<a name="507" href="#507">507</a>                         Map&lt;String, Class&lt;?>> entityTypes = <strong>new</strong> HashMap&lt;String, Class&lt;?>>(readTypes);
<a name="508" href="#508">508</a>                         entityTypes.putAll(writeTypes);
<a name="509" href="#509">509</a>                         ArrayList&lt;String> keys = <strong>new</strong> ArrayList&lt;String>(entityTypes.keySet());
<a name="510" href="#510">510</a>                         Collections.sort(keys);
<a name="511" href="#511">511</a>                         <strong>for</strong> (String key : keys) {
<a name="512" href="#512">512</a>                             Class&lt;?> type = entityTypes.get(key);
<a name="513" href="#513">513</a>                             sb.append(<span class="string">"          &lt;field>\n"</span>);
<a name="514" href="#514">514</a>                             sb.append(<span class="string">"            &lt;name>"</span>+ key +<span class="string">"&lt;/name>\n"</span>);
<a name="515" href="#515">515</a>                             sb.append(<span class="string">"            &lt;type>"</span>+ type.getName() +<span class="string">"&lt;/type>\n"</span>);
<a name="516" href="#516">516</a>                             sb.append(<span class="string">"            &lt;readable>"</span>+ readTypes.containsKey(key) +<span class="string">"&lt;/readable>\n"</span>);
<a name="517" href="#517">517</a>                             sb.append(<span class="string">"            &lt;writeable>"</span>+ writeTypes.containsKey(key) +<span class="string">"&lt;/writeable>\n"</span>);
<a name="518" href="#518">518</a>                             String fieldDesc = getEntityDescription(prefix, FIELD_KEY_PREFIX + key, locale);
<a name="519" href="#519">519</a>                             <strong>if</strong> (fieldDesc != <strong>null</strong>) {
<a name="520" href="#520">520</a>                                 sb.append(<span class="string">"            &lt;description>"</span>+ fieldDesc +<span class="string">"&lt;/description>\n"</span>);
<a name="521" href="#521">521</a>                             }
<a name="522" href="#522">522</a>                             sb.append(<span class="string">"          &lt;/field>\n"</span>);
<a name="523" href="#523">523</a>                         }
<a name="524" href="#524">524</a>                         sb.append(<span class="string">"        &lt;/fields>\n"</span>);
<a name="525" href="#525">525</a>                     }
<a name="526" href="#526">526</a>                     sb.append(<span class="string">"      &lt;/entityClass>\n"</span>);
<a name="527" href="#527">527</a>                 }
<a name="528" href="#528">528</a> 
<a name="529" href="#529">529</a>                 <em class="comment">// Redirects</em>
<a name="530" href="#530">530</a>                 List&lt;URLRedirect> redirects = entityProviderMethodStore.getURLRedirects(prefix);
<a name="531" href="#531">531</a>                 <strong>if</strong> (! redirects.isEmpty()) {
<a name="532" href="#532">532</a>                     sb.append(<span class="string">"      &lt;redirects>\n"</span>);
<a name="533" href="#533">533</a>                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; redirects.size(); i++) {
<a name="534" href="#534">534</a>                         URLRedirect redirect = redirects.get(i);
<a name="535" href="#535">535</a>                         sb.append(<span class="string">"        &lt;redirect>\n"</span>);
<a name="536" href="#536">536</a>                         sb.append(<span class="string">"          &lt;template>"</span>+redirect.template+<span class="string">"&lt;/template>\n"</span>);
<a name="537" href="#537">537</a>                         <strong>if</strong> (redirect.outgoingTemplate != <strong>null</strong>) {
<a name="538" href="#538">538</a>                             sb.append(<span class="string">"          &lt;outgoingTemplate>"</span>+redirect.outgoingTemplate+<span class="string">"&lt;/outgoingTemplate>\n"</span>);
<a name="539" href="#539">539</a>                         }
<a name="540" href="#540">540</a>                         <strong>if</strong> (redirect.methodName != <strong>null</strong>) {
<a name="541" href="#541">541</a>                             sb.append(<span class="string">"          &lt;methodName>"</span>+redirect.methodName+<span class="string">"&lt;/methodName>\n"</span>);
<a name="542" href="#542">542</a>                         }
<a name="543" href="#543">543</a>                         String redirectDesc = getEntityDescription(prefix, REDIRECT_KEY_PREFIX + redirect.template, locale);
<a name="544" href="#544">544</a>                         <strong>if</strong> (redirectDesc != <strong>null</strong>) {
<a name="545" href="#545">545</a>                             sb.append(<span class="string">"          &lt;description>"</span>+redirectDesc+<span class="string">"&lt;/description>\n"</span>);
<a name="546" href="#546">546</a>                         }
<a name="547" href="#547">547</a>                         sb.append(<span class="string">"          &lt;controllable>"</span>+redirect.controllable+<span class="string">"&lt;/controllable>\n"</span>);
<a name="548" href="#548">548</a>                         sb.append(<span class="string">"          &lt;order>"</span>+i+<span class="string">"&lt;/order>\n"</span>);
<a name="549" href="#549">549</a>                         sb.append(<span class="string">"        &lt;/redirect>\n"</span>);
<a name="550" href="#550">550</a>                     }
<a name="551" href="#551">551</a>                     sb.append(<span class="string">"      &lt;/redirects>\n"</span>);
<a name="552" href="#552">552</a>                 }
<a name="553" href="#553">553</a>             }
<a name="554" href="#554">554</a>             <em class="comment">// now capabilities</em>
<a name="555" href="#555">555</a>             sb.append(<span class="string">"      &lt;capabilities>\n"</span>);
<a name="556" href="#556">556</a>             <strong>for</strong> (Class&lt;? <strong>extends</strong> EntityProvider> <strong>class</strong>1 : caps) {
<a name="557" href="#557">557</a>                 sb.append(<span class="string">"        &lt;capability>\n"</span>);
<a name="558" href="#558">558</a>                 sb.append(<span class="string">"          &lt;name>"</span>+<strong>class</strong>1.getSimpleName()+<span class="string">"&lt;/name>\n"</span>);
<a name="559" href="#559">559</a>                 sb.append(<span class="string">"          &lt;type>"</span>+<strong>class</strong>1.getName()+<span class="string">"&lt;/type>\n"</span>);
<a name="560" href="#560">560</a>                 <strong>if</strong> (extra) {
<a name="561" href="#561">561</a>                     String capabilityDescription = getEntityDescription(prefix, <strong>class</strong>1.getSimpleName(), locale);
<a name="562" href="#562">562</a>                     <strong>if</strong> (capabilityDescription != <strong>null</strong>) {
<a name="563" href="#563">563</a>                         sb.append(<span class="string">"          &lt;description>"</span> + capabilityDescription + <span class="string">"&lt;/description>\n"</span>);                  
<a name="564" href="#564">564</a>                     }
<a name="565" href="#565">565</a>                 }
<a name="566" href="#566">566</a>                 sb.append(<span class="string">"        &lt;/capability>\n"</span>);
<a name="567" href="#567">567</a>             }
<a name="568" href="#568">568</a>             sb.append(<span class="string">"      &lt;/capabilities>\n"</span>);
<a name="569" href="#569">569</a>             sb.append(<span class="string">"    &lt;/prefix>\n"</span>);
<a name="570" href="#570">570</a>         } <strong>else</strong> {
<a name="571" href="#571">571</a>             <em class="comment">// just do HTML if not one of the handled ones</em>
<a name="572" href="#572">572</a>             String describePrefixUrl = directUrl + <span class="string">"/"</span> + prefix + SLASH_DESCRIBE;
<a name="573" href="#573">573</a>             sb.append(<span class="string">"    &lt;h3>&lt;a href='"</span>+describePrefixUrl+<span class="string">"'>"</span>+prefix+<span class="string">"&lt;/a>"</span>
<a name="574" href="#574">574</a>                     + makeFormatUrlHtml(describePrefixUrl, Formats.XML) +<span class="string">"&lt;/h3>\n"</span>);
<a name="575" href="#575">575</a>             String description = getEntityDescription(prefix, <strong>null</strong>, locale);
<a name="576" href="#576">576</a>             <strong>if</strong> (description != <strong>null</strong>) {
<a name="577" href="#577">577</a>                 sb.append(<span class="string">"      &lt;div style='font-style: italics; padding-left:0.5em; padding-bottom:0.4em; width:90%;'>"</span> + description + <span class="string">"&lt;/div>\n"</span>);
<a name="578" href="#578">578</a>             }
<a name="579" href="#579">579</a>             <strong>if</strong> (extra) {
<a name="580" href="#580">580</a>                 sb.append(<span class="string">"      &lt;div style='font-style: italics; padding-left:1em;'>"</span> +
<a name="581" href="#581">581</a>                 <span class="string">"RESTful URLs: &lt;a href='http://microformats.org/wiki/rest/urls'>http://microformats.org/wiki/rest/urls&lt;/a>&lt;/div>\n"</span>);
<a name="582" href="#582">582</a>                 String[] outputFormats = getFormats(prefix, <strong>true</strong>);
<a name="583" href="#583">583</a> 
<a name="584" href="#584">584</a>                 <em class="comment">// URLs</em>
<a name="585" href="#585">585</a>                 EntityView ev = entityBrokerManager.makeEntityView(<strong>new</strong> EntityReference(prefix, id), <strong>null</strong>, <strong>null</strong>);
<a name="586" href="#586">586</a>                 String url = <span class="string">""</span>;
<a name="587" href="#587">587</a>                 <strong>if</strong> (caps.contains(CollectionResolvable.<strong>class</strong>) 
<a name="588" href="#588">588</a>                         || caps.contains(Createable.<strong>class</strong>)
<a name="589" href="#589">589</a>                         || caps.contains(CoreEntityProvider.<strong>class</strong>) 
<a name="590" href="#590">590</a>                         || caps.contains(Resolvable.<strong>class</strong>)
<a name="591" href="#591">591</a>                         || caps.contains(Updateable.<strong>class</strong>)
<a name="592" href="#592">592</a>                         || caps.contains(Deleteable.<strong>class</strong>)) {
<a name="593" href="#593">593</a>                     sb.append(<span class="string">"      &lt;h4 style='padding-left:0.5em;margin-bottom:0.2em;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.sample.urls"</span>, locale)
<a name="594" href="#594">594</a>                             +<span class="string">" (_id='"</span>+id+<span class="string">"') ["</span>
<a name="595" href="#595">595</a>                             +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.may.be.invalid"</span>, locale)+<span class="string">"]:&lt;/h4>\n"</span>);
<a name="596" href="#596">596</a>                     sb.append(<span class="string">"      &lt;div style='padding-left:1em;padding-bottom:1em;'>\n"</span>);
<a name="597" href="#597">597</a>                     <strong>if</strong> (caps.contains(CollectionResolvable.<strong>class</strong>)) {
<a name="598" href="#598">598</a>                         url = ev.getEntityURL(EntityView.VIEW_LIST, <strong>null</strong>);
<a name="599" href="#599">599</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="600" href="#600">600</a>                         sb.append(<span class="string">"          &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.collection.url"</span>, locale)
<a name="601" href="#601">601</a>                                 +<span class="string">": GET &lt;a href='"</span>+ directUrl+url +<span class="string">"'>"</span>+url+<span class="string">"&lt;/a>"</span>
<a name="602" href="#602">602</a>                                 + makeFormatsUrlHtml(directUrl+url, outputFormats) +<span class="string">"&lt;/div>\n"</span>);
<a name="603" href="#603">603</a>                         String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_LIST, locale);
<a name="604" href="#604">604</a>                         <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="605" href="#605">605</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+viewDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="606" href="#606">606</a>                         }
<a name="607" href="#607">607</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="608" href="#608">608</a>                     }
<a name="609" href="#609">609</a>                     <strong>if</strong> (caps.contains(Createable.<strong>class</strong>)) {
<a name="610" href="#610">610</a>                         url = ev.getEntityURL(EntityView.VIEW_NEW, <strong>null</strong>);
<a name="611" href="#611">611</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="612" href="#612">612</a>                         sb.append(<span class="string">"          &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.create.url"</span>, locale)
<a name="613" href="#613">613</a>                                 +<span class="string">": POST &lt;a href='"</span>+ directUrl+url +<span class="string">"'>"</span>+url+<span class="string">"&lt;/a>&lt;/div>\n"</span>);
<a name="614" href="#614">614</a>                         String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_NEW, locale);
<a name="615" href="#615">615</a>                         <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="616" href="#616">616</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+viewDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="617" href="#617">617</a>                         }
<a name="618" href="#618">618</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="619" href="#619">619</a>                     }
<a name="620" href="#620">620</a>     
<a name="621" href="#621">621</a>                     <strong>if</strong> (caps.contains(CoreEntityProvider.<strong>class</strong>) || caps.contains(Resolvable.<strong>class</strong>)) {
<a name="622" href="#622">622</a>                         url = ev.getEntityURL(EntityView.VIEW_SHOW, <strong>null</strong>);
<a name="623" href="#623">623</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="624" href="#624">624</a>                         sb.append(<span class="string">"          &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.show.url"</span>, locale)
<a name="625" href="#625">625</a>                                 +<span class="string">": GET &lt;a href='"</span>+ directUrl+url +<span class="string">"'>"</span>+url+<span class="string">"&lt;/a>"</span>
<a name="626" href="#626">626</a>                                 + makeFormatsUrlHtml(directUrl+url, outputFormats) +<span class="string">"&lt;/div>\n"</span>);
<a name="627" href="#627">627</a>                         String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_SHOW, locale);
<a name="628" href="#628">628</a>                         <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="629" href="#629">629</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+viewDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="630" href="#630">630</a>                         }
<a name="631" href="#631">631</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="632" href="#632">632</a>                     }
<a name="633" href="#633">633</a>     
<a name="634" href="#634">634</a>                     <strong>if</strong> (caps.contains(Updateable.<strong>class</strong>)) {
<a name="635" href="#635">635</a>                         url = ev.getEntityURL(EntityView.VIEW_EDIT, <strong>null</strong>);
<a name="636" href="#636">636</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="637" href="#637">637</a>                         sb.append(<span class="string">"          &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.update.url"</span>, locale)
<a name="638" href="#638">638</a>                                 +<span class="string">": PUT &lt;a href='"</span>+ directUrl+url +<span class="string">"'>"</span>+url+<span class="string">"&lt;/a>&lt;/div>\n"</span>);
<a name="639" href="#639">639</a>                         String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_EDIT, locale);
<a name="640" href="#640">640</a>                         <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="641" href="#641">641</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+viewDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="642" href="#642">642</a>                         }
<a name="643" href="#643">643</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="644" href="#644">644</a>                     }
<a name="645" href="#645">645</a>                     <strong>if</strong> (caps.contains(Deleteable.<strong>class</strong>)) {
<a name="646" href="#646">646</a>                         url = ev.getEntityURL(EntityView.VIEW_DELETE, <strong>null</strong>);
<a name="647" href="#647">647</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="648" href="#648">648</a>                         sb.append(<span class="string">"          &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.delete.url"</span>, locale)
<a name="649" href="#649">649</a>                                 +<span class="string">": DELETE &lt;a href='"</span>+ directUrl+url +<span class="string">"'>"</span>+url+<span class="string">"&lt;/a>&lt;/div>\n"</span>);
<a name="650" href="#650">650</a>                         String viewDesc = getEntityDescription(prefix, VIEW_KEY_PREFIX + EntityView.VIEW_DELETE, locale);
<a name="651" href="#651">651</a>                         <strong>if</strong> (viewDesc != <strong>null</strong>) {
<a name="652" href="#652">652</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+viewDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="653" href="#653">653</a>                         }
<a name="654" href="#654">654</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="655" href="#655">655</a>                     }
<a name="656" href="#656">656</a>                     sb.append(<span class="string">"      &lt;/div>\n"</span>);
<a name="657" href="#657">657</a>                 }
<a name="658" href="#658">658</a> 
<a name="659" href="#659">659</a>                 <em class="comment">// Custom Actions</em>
<a name="660" href="#660">660</a>                 List&lt;CustomAction> customActions = entityProviderMethodStore.getCustomActions(prefix);
<a name="661" href="#661">661</a>                 <strong>if</strong> (! customActions.isEmpty()) {
<a name="662" href="#662">662</a>                     sb.append(<span class="string">"      &lt;h4 style='padding-left:0.5em;margin-bottom:0.2em;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.custom.actions"</span>, locale)+<span class="string">"&lt;/h4>\n"</span>);
<a name="663" href="#663">663</a>                     sb.append(<span class="string">"      &lt;div style='padding-left:1em;padding-bottom:1em;'>\n"</span>);
<a name="664" href="#664">664</a>                     <strong>for</strong> (CustomAction customAction : customActions) {
<a name="665" href="#665">665</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="666" href="#666">666</a>                         String actionURL = makeActionURL(ev, customAction);
<a name="667" href="#667">667</a>                         String formatsHtml = <span class="string">""</span>;
<a name="668" href="#668">668</a>                         <strong>if</strong> (customAction.viewKey == <strong>null</strong> 
<a name="669" href="#669">669</a>                                 || EntityView.VIEW_LIST.equals(customAction.viewKey)
<a name="670" href="#670">670</a>                                 || EntityView.VIEW_SHOW.equals(customAction.viewKey)) {
<a name="671" href="#671">671</a>                             formatsHtml = makeFormatsUrlHtml(directUrl+actionURL, outputFormats);
<a name="672" href="#672">672</a>                         }
<a name="673" href="#673">673</a>                         sb.append(<span class="string">"          &lt;a style='font-weight:bold;' href='"</span>+directUrl+actionURL+<span class="string">"'>"</span>
<a name="674" href="#674">674</a>                                 + customAction.action+<span class="string">"&lt;/a> : "</span> 
<a name="675" href="#675">675</a>                                 + <span class="string">"&lt;span>"</span>+makeCustomActionKeyMethodText(customAction)+<span class="string">"&lt;/span> : "</span>
<a name="676" href="#676">676</a>                                 + <span class="string">"&lt;span>["</span>+actionURL+<span class="string">"]&lt;/span> "</span>
<a name="677" href="#677">677</a>                                 + formatsHtml
<a name="678" href="#678">678</a>                                 + <span class="string">"&lt;br/>\n"</span>);
<a name="679" href="#679">679</a>                         String actionDesc = getEntityDescription(prefix, ACTION_KEY_PREFIX + customAction.action, locale);
<a name="680" href="#680">680</a>                         <strong>if</strong> (actionDesc != <strong>null</strong>) {
<a name="681" href="#681">681</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+actionDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="682" href="#682">682</a>                         }
<a name="683" href="#683">683</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="684" href="#684">684</a>                     }
<a name="685" href="#685">685</a>                     sb.append(<span class="string">"      &lt;/div>\n"</span>);
<a name="686" href="#686">686</a>                 }
<a name="687" href="#687">687</a> 
<a name="688" href="#688">688</a>                 <em class="comment">// Data Handling</em>
<a name="689" href="#689">689</a>                 sb.append(<span class="string">"      &lt;h4 style='padding-left:0.5em;margin-bottom:0.2em;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.data.handling"</span>, locale)+<span class="string">"&lt;/h4>\n"</span>);
<a name="690" href="#690">690</a>                 sb.append(<span class="string">"      &lt;div style='padding-left:1em;padding-bottom:1em;'>\n"</span>);
<a name="691" href="#691">691</a>                 sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.formats.output"</span>, locale)+<span class="string">" : "</span>
<a name="692" href="#692">692</a>                         + makeFormatsString(outputFormats, EntityEncodingManager.HANDLED_OUTPUT_FORMATS, locale) +<span class="string">"&lt;/div>\n"</span>);
<a name="693" href="#693">693</a>                 String outputDesc = getEntityDescription(prefix, OUTPUT_DESCRIBE_KEY, locale);
<a name="694" href="#694">694</a>                 <strong>if</strong> (outputDesc != <strong>null</strong>) {
<a name="695" href="#695">695</a>                     sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+outputDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="696" href="#696">696</a>                 }
<a name="697" href="#697">697</a>                 String[] inputFormats = getFormats(prefix, false);
<a name="698" href="#698">698</a>                 sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.formats.input"</span>, locale)+<span class="string">" : "</span>
<a name="699" href="#699">699</a>                         + makeFormatsString(inputFormats, EntityEncodingManager.HANDLED_INPUT_FORMATS, locale) +<span class="string">"&lt;/div>\n"</span>);
<a name="700" href="#700">700</a>                 String intputDesc = getEntityDescription(prefix, INPUT_DESCRIBE_KEY, locale);
<a name="701" href="#701">701</a>                 <strong>if</strong> (intputDesc != <strong>null</strong>) {
<a name="702" href="#702">702</a>                     sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+intputDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="703" href="#703">703</a>                 }
<a name="704" href="#704">704</a> 
<a name="705" href="#705">705</a>                 EntityViewAccessProvider evap = entityViewAccessProviderManager.getProvider(prefix);
<a name="706" href="#706">706</a>                 <strong>if</strong> (evap != <strong>null</strong>) {
<a name="707" href="#707">707</a>                     sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.data.access.provider"</span>, locale)+<span class="string">" : "</span>+ EntityViewAccessProvider.<strong>class</strong>.getSimpleName() +<span class="string">"&lt;/div>\n"</span>);
<a name="708" href="#708">708</a>                     <strong>if</strong> (AccessFormats.<strong>class</strong>.isAssignableFrom(evap.getClass())) {
<a name="709" href="#709">709</a>                         String[] accessFormats = ((AccessFormats)evap).getHandledAccessFormats();
<a name="710" href="#710">710</a>                         sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.formats.access"</span>, locale)+<span class="string">" : "</span>
<a name="711" href="#711">711</a>                                 + makeFormatsString(accessFormats, <strong>null</strong>, locale) +<span class="string">"&lt;/div>\n"</span>);
<a name="712" href="#712">712</a>                     }
<a name="713" href="#713">713</a>                     sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.data.access.provider"</span>, locale)+<span class="string">" : "</span>+ EntityViewAccessProvider.<strong>class</strong>.getSimpleName() +<span class="string">"&lt;/div>\n"</span>);
<a name="714" href="#714">714</a>                 } <strong>else</strong> <strong>if</strong> (httpServletAccessProviderManager.getProvider(prefix) != <strong>null</strong>) {
<a name="715" href="#715">715</a>                     sb.append(<span class="string">"        &lt;div>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.data.access.provider"</span>, locale)+<span class="string">" : "</span>+ HttpServletAccessProvider.<strong>class</strong>.getSimpleName() +<span class="string">"&lt;/div>\n"</span>);
<a name="716" href="#716">716</a>                 } <strong>else</strong> {
<a name="717" href="#717">717</a>                     sb.append(<span class="string">"        &lt;div style='font-style:italic;padding-left:1em'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.data.access.provider.none"</span>, locale) +<span class="string">"&lt;/div>\n"</span>);
<a name="718" href="#718">718</a>                 }
<a name="719" href="#719">719</a>                 sb.append(<span class="string">"      &lt;/div>\n"</span>);
<a name="720" href="#720">720</a> 
<a name="721" href="#721">721</a>                 <em class="comment">// Resolvable Entity Info</em>
<a name="722" href="#722">722</a>                 Object entity = entityBrokerManager.getSampleEntityObject(prefix, <strong>null</strong>);
<a name="723" href="#723">723</a>                 <strong>if</strong> (entity != <strong>null</strong>) {
<a name="724" href="#724">724</a>                     Class&lt;?> entityType = entity.getClass();
<a name="725" href="#725">725</a>                     sb.append(<span class="string">"      &lt;h4 style='padding-left:0.5em;margin-bottom:0.2em;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.class"</span>, locale)+<span class="string">" : "</span>+ entityType.getName() +<span class="string">"&lt;/h4>\n"</span>);
<a name="726" href="#726">726</a>                     sb.append(<span class="string">"      &lt;div style='padding-left:1em;padding-bottom:1em;'>\n"</span>);
<a name="727" href="#727">727</a>                     <strong>if</strong> (ConstructorUtils.isClassSimple(entityType)) {
<a name="728" href="#728">728</a>                         sb.append( makeResolveType(<span class="string">"simple"</span>, <strong>null</strong>, locale));
<a name="729" href="#729">729</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassCollection(entityType)) {
<a name="730" href="#730">730</a>                         sb.append( makeResolveType(<span class="string">"collection"</span>, <strong>null</strong>, locale));
<a name="731" href="#731">731</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassArray(entityType)) {
<a name="732" href="#732">732</a>                         String cType = <span class="string">"Component Class: "</span> + ArrayUtils.type((Object[])entity).getName();
<a name="733" href="#733">733</a>                         sb.append( makeResolveType(<span class="string">"array"</span>, cType, locale));
<a name="734" href="#734">734</a>                     } <strong>else</strong> <strong>if</strong> (ConstructorUtils.isClassMap(entityType)) {
<a name="735" href="#735">735</a>                         <em class="comment">// get the types of the map keys if possible</em>
<a name="736" href="#736">736</a>                         String mapTypes = <strong>null</strong>;
<a name="737" href="#737">737</a>                         Map m = (Map) entity;
<a name="738" href="#738">738</a>                         <strong>if</strong> (m.size() > 0) {
<a name="739" href="#739">739</a>                             Entry entry = (Entry) m.entrySet().iterator().next();
<a name="740" href="#740">740</a>                             mapTypes = (entry.getKey()==<strong>null</strong>?Object.<strong>class</strong>.getName():entry.getKey().getClass().getName())
<a name="741" href="#741">741</a>                                 +<span class="string">" => "</span>
<a name="742" href="#742">742</a>                                 +(entry.getValue()==<strong>null</strong>?Object.<strong>class</strong>.getName():entry.getValue().getClass().getName());
<a name="743" href="#743">743</a>                         }
<a name="744" href="#744">744</a>                         sb.append( makeResolveType(<span class="string">"map"</span>, mapTypes, locale));
<a name="745" href="#745">745</a>                     } <strong>else</strong> {
<a name="746" href="#746">746</a>                         sb.append( makeResolveType(<span class="string">"bean"</span>, <strong>null</strong>, locale));
<a name="747" href="#747">747</a>                         sb.append(<span class="string">"        &lt;table width='80%' cellpadding='0' cellspacing='0'>\n"</span>);
<a name="748" href="#748">748</a>                         sb.append(<span class="string">"          &lt;thead>\n"</span>);
<a name="749" href="#749">749</a>                         sb.append(<span class="string">"            &lt;tr>\n"</span>);
<a name="750" href="#750">750</a>                         sb.append(<span class="string">"              &lt;td width='1%'>&lt;/td>\n"</span>);
<a name="751" href="#751">751</a>                         sb.append(<span class="string">"              &lt;td>"</span>+ entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.name"</span>, locale) +<span class="string">"&lt;/td>\n"</span>);
<a name="752" href="#752">752</a>                         sb.append(<span class="string">"              &lt;td>"</span>+ entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.type"</span>, locale) +<span class="string">"&lt;/td>\n"</span>);
<a name="753" href="#753">753</a>                         sb.append(<span class="string">"              &lt;td>"</span>+ entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.field.status"</span>, locale) +<span class="string">"&lt;/td>\n"</span>);
<a name="754" href="#754">754</a>                         sb.append(<span class="string">"            &lt;/tr>\n"</span>);
<a name="755" href="#755">755</a>                         sb.append(<span class="string">"          &lt;/thead>\n"</span>);
<a name="756" href="#756">756</a>                         sb.append(<span class="string">"          &lt;tbody>\n"</span>);
<a name="757" href="#757">757</a>                         <em class="comment">// get all the read and write fields from this object</em>
<a name="758" href="#758">758</a>                         Map&lt;String, Class&lt;?>> readTypes = ReflectUtils.getInstance().getFieldTypes(entity.getClass(), FieldsFilter.SERIALIZABLE);
<a name="759" href="#759">759</a>                         Map&lt;String, Class&lt;?>> writeTypes = ReflectUtils.getInstance().getFieldTypes(entity.getClass(), FieldsFilter.WRITEABLE);
<a name="760" href="#760">760</a>                         Map&lt;String, Class&lt;?>> entityTypes = <strong>new</strong> HashMap&lt;String, Class&lt;?>>(readTypes);
<a name="761" href="#761">761</a>                         entityTypes.putAll(writeTypes);
<a name="762" href="#762">762</a>                         ArrayList&lt;String> keys = <strong>new</strong> ArrayList&lt;String>(entityTypes.keySet());
<a name="763" href="#763">763</a>                         Collections.sort(keys);
<a name="764" href="#764">764</a>                         <strong>for</strong> (<strong>int</strong> i = 0; i &lt; keys.size(); i++) {
<a name="765" href="#765">765</a>                             String key = keys.get(i);
<a name="766" href="#766">766</a>                             Class&lt;?> type = entityTypes.get(key);
<a name="767" href="#767">767</a>                             String status = <strong>null</strong>;
<a name="768" href="#768">768</a>                             String trStyle = <span class="string">""</span>;
<a name="769" href="#769">769</a>                             <strong>if</strong> (! readTypes.containsKey(key)) {
<a name="770" href="#770">770</a>                                 <em class="comment">// write only</em>
<a name="771" href="#771">771</a>                                 status = entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.field.write.only"</span>, locale);
<a name="772" href="#772">772</a>                                 trStyle = <span class="string">" style='color:blue;'"</span>;
<a name="773" href="#773">773</a>                             } <strong>else</strong> <strong>if</strong> (! writeTypes.containsKey(key)) {
<a name="774" href="#774">774</a>                                 <em class="comment">// read only</em>
<a name="775" href="#775">775</a>                                 status = entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.field.read.only"</span>, locale);
<a name="776" href="#776">776</a>                                 trStyle = <span class="string">" style='color:red;'"</span>;
<a name="777" href="#777">777</a>                             } <strong>else</strong> {
<a name="778" href="#778">778</a>                                 <em class="comment">// read/write</em>
<a name="779" href="#779">779</a>                                 status = entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.field.read.write"</span>, locale);
<a name="780" href="#780">780</a>                             }
<a name="781" href="#781">781</a>                             sb.append(<span class="string">"            &lt;tr"</span>+trStyle+<span class="string">">&lt;td>"</span>+(i+1)+<span class="string">")&amp;nbsp;&lt;/td>"</span>
<a name="782" href="#782">782</a>                             		+ <span class="string">"&lt;td style='font-weight:bold;'>"</span>+ key +<span class="string">"&lt;/td>"</span>
<a name="783" href="#783">783</a>                             		+ <span class="string">"&lt;td>"</span>+ type.getName() +<span class="string">"&lt;/td>"</span>
<a name="784" href="#784">784</a>                             		+ <span class="string">"&lt;td style='font-style:italic;'>"</span>+status+<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="785" href="#785">785</a>                             String fieldDesc = getEntityDescription(prefix, FIELD_KEY_PREFIX + key, locale);
<a name="786" href="#786">786</a>                             <strong>if</strong> (fieldDesc != <strong>null</strong>) {
<a name="787" href="#787">787</a>                                 sb.append(<span class="string">"            &lt;tr>&lt;td>&lt;/td>&lt;td colspan='3' style='font-style:italic;font-size:0.9em;'>"</span>);
<a name="788" href="#788">788</a>                                 sb.append(fieldDesc);
<a name="789" href="#789">789</a>                                 sb.append(<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="790" href="#790">790</a>                             }
<a name="791" href="#791">791</a>                         }
<a name="792" href="#792">792</a>                         sb.append(<span class="string">"          &lt;/tbody>\n"</span>);
<a name="793" href="#793">793</a>                         sb.append(<span class="string">"        &lt;/table>\n"</span>);
<a name="794" href="#794">794</a>                     }
<a name="795" href="#795">795</a>                     sb.append(<span class="string">"      &lt;/div>\n"</span>);
<a name="796" href="#796">796</a>                 }
<a name="797" href="#797">797</a> 
<a name="798" href="#798">798</a>                 <em class="comment">// Redirects</em>
<a name="799" href="#799">799</a>                 List&lt;URLRedirect> redirects = entityProviderMethodStore.getURLRedirects(prefix);
<a name="800" href="#800">800</a>                 <strong>if</strong> (! redirects.isEmpty()) {
<a name="801" href="#801">801</a>                     sb.append(<span class="string">"      &lt;h4 style='padding-left:0.5em;margin-bottom:0.2em;'>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.url.redirects"</span>, locale)+<span class="string">"&lt;/h4>\n"</span>);
<a name="802" href="#802">802</a>                     sb.append(<span class="string">"      &lt;div style='padding-left:1em;padding-bottom:1em;'>\n"</span>);
<a name="803" href="#803">803</a>                     <strong>for</strong> (<strong>int</strong> i = 0; i &lt; redirects.size(); i++) {
<a name="804" href="#804">804</a>                         URLRedirect redirect = redirects.get(i);
<a name="805" href="#805">805</a>                         sb.append(<span class="string">"        &lt;div>\n"</span>);
<a name="806" href="#806">806</a>                         String target = replacePrefix(redirect.outgoingTemplate, prefix);
<a name="807" href="#807">807</a>                         <strong>if</strong> (target == <strong>null</strong>) {
<a name="808" href="#808">808</a>                             target = <span class="string">"&lt;i>"</span> + entityProperties.getProperty(DESCRIBE, <span class="string">"describe.url.redirects.no.outgoing"</span>, locale) + <span class="string">"&lt;/i>"</span>;
<a name="809" href="#809">809</a>                         }
<a name="810" href="#810">810</a>                         sb.append(<span class="string">"          &lt;span>"</span>+(i+1)+<span class="string">")&lt;/span> &amp;nbsp; "</span>
<a name="811" href="#811">811</a>                                 + makeRedirectLink(replacePrefix(redirect.template, prefix), directUrl)
<a name="812" href="#812">812</a>                                 + <span class="string">" ==&amp;gt; &lt;span>"</span>+target+<span class="string">"&lt;/span>&lt;br/>\n"</span>);
<a name="813" href="#813">813</a>                         String redirectDesc = getEntityDescription(prefix, REDIRECT_KEY_PREFIX + redirect.template, locale);
<a name="814" href="#814">814</a>                         <strong>if</strong> (redirectDesc != <strong>null</strong>) {
<a name="815" href="#815">815</a>                             sb.append(<span class="string">"          &lt;div style='font-style:italic;font-size:0.9em;padding-left:1.5em;'>"</span>+redirectDesc+<span class="string">"&lt;/div>\n"</span>);
<a name="816" href="#816">816</a>                         }
<a name="817" href="#817">817</a>                         sb.append(<span class="string">"        &lt;/div>\n"</span>);
<a name="818" href="#818">818</a>                     }
<a name="819" href="#819">819</a>                     sb.append(<span class="string">"      &lt;/div>\n"</span>);
<a name="820" href="#820">820</a>                 }
<a name="821" href="#821">821</a>             }
<a name="822" href="#822">822</a> 
<a name="823" href="#823">823</a>             <em class="comment">// Capabilities</em>
<a name="824" href="#824">824</a>             sb.append(<span class="string">"      &lt;div style='font-size:1.1em; font-weight:bold; font-style:italic; padding-left:0.5em;'>"</span>
<a name="825" href="#825">825</a>                     +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities"</span>, locale)+<span class="string">": "</span>+caps.size()+<span class="string">"&lt;/div>\n"</span>);
<a name="826" href="#826">826</a>             <strong>if</strong> (extra) {
<a name="827" href="#827">827</a>                 sb.append(<span class="string">"      &lt;table width='95%' style='padding-left:1.5em;'>\n"</span>);
<a name="828" href="#828">828</a>                 sb.append(<span class="string">"        &lt;tr style='font-size:0.9em;'>&lt;th width='1%'>&lt;/th>&lt;th width='14%'>"</span>
<a name="829" href="#829">829</a>                         +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.name"</span>, locale)
<a name="830" href="#830">830</a>                         +<span class="string">"&lt;/th>&lt;th width='30%'>"</span>
<a name="831" href="#831">831</a>                         +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.type"</span>, locale)
<a name="832" href="#832">832</a>                         +<span class="string">"&lt;/th>"</span>);
<a name="833" href="#833">833</a>                 <strong>if</strong> (extra) {   sb.append(<span class="string">"&lt;th width='55%'>"</span>
<a name="834" href="#834">834</a>                         +entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.description"</span>, locale)
<a name="835" href="#835">835</a>                         +<span class="string">"&lt;/th>"</span>); }
<a name="836" href="#836">836</a>                 sb.append(<span class="string">"&lt;/tr>\n"</span>);
<a name="837" href="#837">837</a>                 <strong>int</strong> counter = 1;
<a name="838" href="#838">838</a>                 <strong>for</strong> (Class&lt;? <strong>extends</strong> EntityProvider> <strong>class</strong>1 : caps) {
<a name="839" href="#839">839</a>                     sb.append(<span class="string">"        &lt;tr style='font-size:0.9em;'>&lt;td>"</span>);
<a name="840" href="#840">840</a>                     sb.append(counter++);
<a name="841" href="#841">841</a>                     sb.append(<span class="string">"&lt;/td>&lt;td>"</span>);
<a name="842" href="#842">842</a>                     sb.append(<strong>class</strong>1.getSimpleName());
<a name="843" href="#843">843</a>                     sb.append(<span class="string">"&lt;/td>&lt;td>"</span>);
<a name="844" href="#844">844</a>                     sb.append(<strong>class</strong>1.getName());
<a name="845" href="#845">845</a>                     sb.append(<span class="string">"&lt;/td>&lt;td>"</span>);
<a name="846" href="#846">846</a>                     <strong>if</strong> (extra) {
<a name="847" href="#847">847</a>                         String capabilityDescription = getEntityDescription(prefix, <strong>class</strong>1.getSimpleName(), locale);
<a name="848" href="#848">848</a>                         <strong>if</strong> (capabilityDescription != <strong>null</strong>) {
<a name="849" href="#849">849</a>                             sb.append(capabilityDescription);
<a name="850" href="#850">850</a>                         }
<a name="851" href="#851">851</a>                     }
<a name="852" href="#852">852</a>                     sb.append(<span class="string">"&lt;/td>&lt;/tr>\n"</span>);
<a name="853" href="#853">853</a>                 }
<a name="854" href="#854">854</a>                 sb.append(<span class="string">"      &lt;/table>\n"</span>);
<a name="855" href="#855">855</a>             }
<a name="856" href="#856">856</a>         }
<a name="857" href="#857">857</a>         <strong>return</strong> sb.toString();
<a name="858" href="#858">858</a>     }
<a name="859" href="#859">859</a> 
<a name="860" href="#860">860</a>     <em>/**<em>*</em></em>
<a name="861" href="#861">861</a> <em>     * Replaces the {prefix} value in the template with the actual prefix,</em>
<a name="862" href="#862">862</a> <em>     * allows nulls to pass through</em>
<a name="863" href="#863">863</a> <em>     */</em>
<a name="864" href="#864">864</a>     <strong>protected</strong> String replacePrefix(String outgoingTemplate, String prefix) {
<a name="865" href="#865">865</a>         <strong>if</strong> (outgoingTemplate != <strong>null</strong>) {
<a name="866" href="#866">866</a>             outgoingTemplate = outgoingTemplate.replace(TemplateParseUtil.PREFIX_VARIABLE, prefix);
<a name="867" href="#867">867</a>         }
<a name="868" href="#868">868</a>         <strong>return</strong> outgoingTemplate;
<a name="869" href="#869">869</a>     }
<a name="870" href="#870">870</a> 
<a name="871" href="#871">871</a>     <em>/**<em>*</em></em>
<a name="872" href="#872">872</a> <em>     * Turn a redirect template into html for a link if it has no variables in it,</em>
<a name="873" href="#873">873</a> <em>     * otherwise output the text of the template in a span with bold</em>
<a name="874" href="#874">874</a> <em>     */</em>
<a name="875" href="#875">875</a>     <strong>protected</strong> String makeRedirectLink(String redirect, String prefixURL) {
<a name="876" href="#876">876</a>         String html = redirect;
<a name="877" href="#877">877</a>         <strong>if</strong> (redirect.indexOf(<span class="string">"{"</span>) > 0 &amp;&amp; redirect.indexOf(<span class="string">"}"</span>) > 0) {
<a name="878" href="#878">878</a>             html = <span class="string">"&lt;span style='font-weight:bold;'>"</span>+redirect+<span class="string">"&lt;/span>"</span>;
<a name="879" href="#879">879</a>         } <strong>else</strong> {
<a name="880" href="#880">880</a>             html = <span class="string">"&lt;a style='font-weight:bold;' href='"</span>+prefixURL+redirect+<span class="string">"'>"</span>+redirect+<span class="string">"&lt;/a>"</span>;
<a name="881" href="#881">881</a>         }
<a name="882" href="#882">882</a>         <strong>return</strong> html;
<a name="883" href="#883">883</a>     }
<a name="884" href="#884">884</a> 
<a name="885" href="#885">885</a>     <em class="comment">// DESCRIBE formatting utilities</em>
<a name="886" href="#886">886</a> 
<a name="887" href="#887">887</a>     <strong>protected</strong> String makeResolveType(String typeName, String extra, Locale locale) {
<a name="888" href="#888">888</a>         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="889" href="#889">889</a>         sb.append(<span class="string">"        &lt;div>&lt;b>"</span>);
<a name="890" href="#890">890</a>         sb.append( entityProperties.getProperty(DESCRIBE, <span class="string">"describe.capabilities.type"</span>, locale) );
<a name="891" href="#891">891</a>         sb.append(<span class="string">" :: "</span>);
<a name="892" href="#892">892</a>         sb.append(typeName);
<a name="893" href="#893">893</a>         sb.append(<span class="string">"&lt;/b>"</span>);
<a name="894" href="#894">894</a>         <strong>if</strong> (extra != <strong>null</strong>) {
<a name="895" href="#895">895</a>             sb.append(<span class="string">" ("</span>);
<a name="896" href="#896">896</a>             sb.append(extra);
<a name="897" href="#897">897</a>             sb.append(<span class="string">") "</span>);
<a name="898" href="#898">898</a>         }
<a name="899" href="#899">899</a>         sb.append(<span class="string">"&lt;/div>\n"</span>);
<a name="900" href="#900">900</a>         <strong>return</strong> sb.toString();
<a name="901" href="#901">901</a>     }
<a name="902" href="#902">902</a> 
<a name="903" href="#903">903</a>     <em>/**<em>*</em></em>
<a name="904" href="#904">904</a> <em>     * @param customAction</em>
<a name="905" href="#905">905</a> <em>     * @return a URL for triggering the custom action (without <a href="http://server/direct)" target="alexandria_uri">http://server/direct)</a></em>
<a name="906" href="#906">906</a> <em>     */</em>
<a name="907" href="#907">907</a>     <strong>protected</strong> String makeActionURL(EntityView ev, CustomAction customAction) {
<a name="908" href="#908">908</a>         <em class="comment">// switched to this since it is more correct</em>
<a name="909" href="#909">909</a>         String URL = EntityView.SEPARATOR + ev.getEntityReference().getPrefix() + EntityView.SEPARATOR + customAction.action;
<a name="910" href="#910">910</a>         String viewKey = customAction.viewKey;
<a name="911" href="#911">911</a>         <strong>if</strong> (viewKey != <strong>null</strong> || EntityView.VIEW_SHOW.equals(viewKey)) {
<a name="912" href="#912">912</a>             URL = ev.getEntityURL(viewKey, <strong>null</strong>) + EntityView.SEPARATOR + customAction.action;
<a name="913" href="#913">913</a>         }
<a name="914" href="#914">914</a>         <strong>return</strong> URL;
<a name="915" href="#915">915</a>     }
<a name="916" href="#916">916</a> 
<a name="917" href="#917">917</a>     <em>/**<em>*</em></em>
<a name="918" href="#918">918</a> <em>     * Create text to display for the CA key and method</em>
<a name="919" href="#919">919</a> <em>     * @param customAction</em>
<a name="920" href="#920">920</a> <em>     * @return</em>
<a name="921" href="#921">921</a> <em>     */</em>
<a name="922" href="#922">922</a>     <strong>protected</strong> String makeCustomActionKeyMethodText(CustomAction customAction) {
<a name="923" href="#923">923</a>         String togo = <span class="string">"*"</span>;
<a name="924" href="#924">924</a>         <strong>if</strong> (customAction.viewKey != <strong>null</strong> &amp;&amp; ! <span class="string">""</span>.equals(customAction.viewKey)) {
<a name="925" href="#925">925</a>             togo = customAction.viewKey+<span class="string">" ("</span>+EntityView.translateViewKeyToMethod(customAction.viewKey)+<span class="string">")"</span>;
<a name="926" href="#926">926</a>         }
<a name="927" href="#927">927</a>         <strong>return</strong> togo;
<a name="928" href="#928">928</a>     }
<a name="929" href="#929">929</a> 
<a name="930" href="#930">930</a>     <em>/**<em>*</em></em>
<a name="931" href="#931">931</a> <em>     * @return all the format extensions handled by this, null if none handled, empty if all</em>
<a name="932" href="#932">932</a> <em>     */</em>
<a name="933" href="#933">933</a>     <strong>protected</strong> String[] getFormats(String prefix, <strong>boolean</strong> output) {
<a name="934" href="#934">934</a>         String[] formats = <strong>null</strong>;
<a name="935" href="#935">935</a>         <strong>try</strong> {
<a name="936" href="#936">936</a>             <strong>if</strong> (output) {
<a name="937" href="#937">937</a>                 formats = entityProviderManager.getProviderByPrefixAndCapability(prefix, Outputable.<strong>class</strong>).getHandledOutputFormats();
<a name="938" href="#938">938</a>             } <strong>else</strong> {
<a name="939" href="#939">939</a>                 formats = entityProviderManager.getProviderByPrefixAndCapability(prefix, Inputable.<strong>class</strong>).getHandledInputFormats();
<a name="940" href="#940">940</a>             }
<a name="941" href="#941">941</a>         } <strong>catch</strong> (NullPointerException e) {
<a name="942" href="#942">942</a>             formats = <strong>null</strong>;
<a name="943" href="#943">943</a>         }
<a name="944" href="#944">944</a>         EntityViewAccessProvider evap = entityViewAccessProviderManager.getProvider(prefix);
<a name="945" href="#945">945</a>         <strong>if</strong> (evap != <strong>null</strong>) {
<a name="946" href="#946">946</a>             <strong>if</strong> (AccessFormats.<strong>class</strong>.isAssignableFrom(evap.getClass())) {
<a name="947" href="#947">947</a>                 String[] accessFormats = ((AccessFormats)evap).getHandledAccessFormats();
<a name="948" href="#948">948</a>                 <strong>if</strong> (accessFormats != <strong>null</strong>) {
<a name="949" href="#949">949</a>                     <strong>if</strong> (accessFormats.length > 0) {
<a name="950" href="#950">950</a>                         <strong>if</strong> (formats == <strong>null</strong>) {
<a name="951" href="#951">951</a>                             formats = accessFormats;
<a name="952" href="#952">952</a>                         } <strong>else</strong> {
<a name="953" href="#953">953</a>                             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; accessFormats.length; i++) {
<a name="954" href="#954">954</a>                                 <strong>if</strong> (! ReflectUtils.contains(formats, accessFormats[i])) {
<a name="955" href="#955">955</a>                                     ReflectUtils.appendArray(formats, accessFormats[i]);
<a name="956" href="#956">956</a>                                 }
<a name="957" href="#957">957</a>                             }
<a name="958" href="#958">958</a>                         }
<a name="959" href="#959">959</a>                     }
<a name="960" href="#960">960</a>                 }
<a name="961" href="#961">961</a>             }
<a name="962" href="#962">962</a>         }
<a name="963" href="#963">963</a>         <strong>return</strong> formats;
<a name="964" href="#964">964</a>     }
<a name="965" href="#965">965</a> 
<a name="966" href="#966">966</a>     <strong>protected</strong> String makeFormatsUrlHtml(String url, String[] formats) {
<a name="967" href="#967">967</a>         StringBuilder sb = <strong>new</strong> StringBuilder();
<a name="968" href="#968">968</a>         <strong>if</strong> (formats != <strong>null</strong>) {
<a name="969" href="#969">969</a>             <strong>for</strong> (String <strong>for</strong>mat : <strong>for</strong>mats) {
<a name="970" href="#970">970</a>                 sb.append( makeFormatUrlHtml(url, format) );
<a name="971" href="#971">971</a>             }
<a name="972" href="#972">972</a>         }
<a name="973" href="#973">973</a>         <strong>return</strong> sb.toString();
<a name="974" href="#974">974</a>     }
<a name="975" href="#975">975</a> 
<a name="976" href="#976">976</a>     <strong>protected</strong> String makeFormatsString(String[] formats, String[] extraFormats, Locale locale) {
<a name="977" href="#977">977</a>         String s = <span class="string">""</span>;
<a name="978" href="#978">978</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="979" href="#979">979</a>             locale = entityProperties.getLocale();
<a name="980" href="#980">980</a>         }
<a name="981" href="#981">981</a>         <strong>if</strong> (formats == <strong>null</strong>) {
<a name="982" href="#982">982</a>             s = <span class="string">"&lt;i>"</span>+entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.formats.none"</span>, locale)+<span class="string">"&lt;/i>"</span>;
<a name="983" href="#983">983</a>         } <strong>else</strong> <strong>if</strong> (formats.length == 0) {
<a name="984" href="#984">984</a>             <em class="comment">// all</em>
<a name="985" href="#985">985</a>             String all = <span class="string">"*"</span>;
<a name="986" href="#986">986</a>             <strong>if</strong> (extraFormats != <strong>null</strong> &amp;&amp; extraFormats.length > 0) {
<a name="987" href="#987">987</a>                 all = makeArrayIntoString(formats) + <span class="string">",*"</span>;
<a name="988" href="#988">988</a>             }
<a name="989" href="#989">989</a>             s = <span class="string">"&lt;i>"</span> + entityProperties.getProperty(DESCRIBE, <span class="string">"describe.entity.formats.all"</span>, locale) + <span class="string">" ("</span> + all + <span class="string">")&lt;/i>"</span>;
<a name="990" href="#990">990</a>         } <strong>else</strong> {
<a name="991" href="#991">991</a>             s = makeArrayIntoString( formats );
<a name="992" href="#992">992</a>         }
<a name="993" href="#993">993</a>         <strong>return</strong> s;
<a name="994" href="#994">994</a>     }
<a name="995" href="#995">995</a> 
<a name="996" href="#996">996</a>     <strong>protected</strong> String makeFormatUrlHtml(String url, String format) {
<a name="997" href="#997">997</a>         <strong>return</strong> <span class="string">" (&lt;a href='"</span>+url+<span class="string">"."</span>+format+<span class="string">"'>"</span>+format+<span class="string">"&lt;/a>)"</span>;
<a name="998" href="#998">998</a>     }
<a name="999" href="#999">999</a> 
<a name="1000" href="#1000">1000</a>     <strong>protected</strong> String makeArrayIntoString(Object[] array) {
<a name="1001" href="#1001">1001</a>         StringBuilder result = <strong>new</strong> StringBuilder();
<a name="1002" href="#1002">1002</a>         <strong>if</strong> (array != <strong>null</strong> &amp;&amp; array.length > 0) {
<a name="1003" href="#1003">1003</a>             <strong>for</strong> (<strong>int</strong> i = 0; i &lt; array.length; i++) {
<a name="1004" href="#1004">1004</a>                 <strong>if</strong> (i > 0) {
<a name="1005" href="#1005">1005</a>                     result.append(<span class="string">", "</span>);
<a name="1006" href="#1006">1006</a>                 }
<a name="1007" href="#1007">1007</a>                 <strong>if</strong> (array[i] != <strong>null</strong>) {
<a name="1008" href="#1008">1008</a>                     result.append(array[i].toString());
<a name="1009" href="#1009">1009</a>                 }
<a name="1010" href="#1010">1010</a>             }
<a name="1011" href="#1011">1011</a>         }
<a name="1012" href="#1012">1012</a>         <strong>return</strong> result.toString();
<a name="1013" href="#1013">1013</a>     }
<a name="1014" href="#1014">1014</a> 
<a name="1015" href="#1015">1015</a>     <em>/**<em>*</em></em>
<a name="1016" href="#1016">1016</a> <em>     * Get the descriptions for an entity OR its capabilities OR custom actions</em>
<a name="1017" href="#1017">1017</a> <em>     * @param prefix an entity prefix</em>
<a name="1018" href="#1018">1018</a> <em>     * @param descriptionkey (optional) the key (simplename for capability, action.actionkey for actions)</em>
<a name="1019" href="#1019">1019</a> <em>     * @param locale the Locale to use for translations</em>
<a name="1020" href="#1020">1020</a> <em>     * @return the description (may be blank) OR null if there is none</em>
<a name="1021" href="#1021">1021</a> <em>     */</em>
<a name="1022" href="#1022">1022</a>     <strong>protected</strong> String getEntityDescription(String prefix, String descriptionkey, Locale locale) {
<a name="1023" href="#1023">1023</a>         String value = <strong>null</strong>;
<a name="1024" href="#1024">1024</a>         <strong>if</strong> (locale == <strong>null</strong>) {
<a name="1025" href="#1025">1025</a>             locale = entityProperties.getLocale();
<a name="1026" href="#1026">1026</a>         }
<a name="1027" href="#1027">1027</a>         <em class="comment">// get from EP first if possible</em>
<a name="1028" href="#1028">1028</a>         DescribeDefineable describer = entityProviderManager.getProviderByPrefixAndCapability(prefix, DescribeDefineable.<strong>class</strong>);
<a name="1029" href="#1029">1029</a>         <strong>if</strong> (describer != <strong>null</strong>) {
<a name="1030" href="#1030">1030</a>             value = describer.getDescription(locale, descriptionkey);
<a name="1031" href="#1031">1031</a>         }
<a name="1032" href="#1032">1032</a>         <em class="comment">// now from the default location if null</em>
<a name="1033" href="#1033">1033</a>         <strong>if</strong> (value == <strong>null</strong>) {
<a name="1034" href="#1034">1034</a>             String key = prefix;
<a name="1035" href="#1035">1035</a>             <strong>if</strong> (descriptionkey != <strong>null</strong>) {
<a name="1036" href="#1036">1036</a>                 <em class="comment">// try simple name first</em>
<a name="1037" href="#1037">1037</a>                 key += <span class="string">"."</span> + descriptionkey;
<a name="1038" href="#1038">1038</a>             }
<a name="1039" href="#1039">1039</a>             value = entityProperties.getProperty(prefix, key, locale);
<a name="1040" href="#1040">1040</a>         }
<a name="1041" href="#1041">1041</a>         <strong>if</strong> (<span class="string">""</span>.equals(value)) {
<a name="1042" href="#1042">1042</a>             value = <strong>null</strong>;
<a name="1043" href="#1043">1043</a>         }
<a name="1044" href="#1044">1044</a>         <strong>return</strong> value;
<a name="1045" href="#1045">1045</a>     }
<a name="1046" href="#1046">1046</a> 
<a name="1047" href="#1047">1047</a> }
</pre>
<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body>
</html>

